Revision: 4248
http://skim-app.svn.sourceforge.net/skim-app/?rev=4248&view=rev
Author: hofman
Date: 2008-07-18 11:29:44 +0000 (Fri, 18 Jul 2008)
Log Message:
-----------
remove some unnecessary headerdoc tags
Modified Paths:
--------------
trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
Modified: trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-18 10:24:36 UTC
(rev 4247)
+++ trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-18 11:29:44 UTC
(rev 4248)
@@ -86,14 +86,12 @@
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Methods from this category are used by the <code>PDFDocument
(SKNExtensions)</code> category to add new annotations from Skim notes.
*/
@interface PDFAnnotation (SKNExtensions)
/*!
- @method
@abstract Initializes a new Skim note annotation. This is the
designated initializer for a Skim note.
@discussion This method can be implemented in subclasses to provide
default properties for Skim notes.
@param bounds The bounding box of the annotation, in page space.
@@ -102,7 +100,6 @@
- (id)initSkimNoteWithBounds:(NSRect)bounds;
/*!
- @method
@abstract Initializes a new Skim note annotation with the given
properties.
@discussion This method determines the proper subclass from the value for
the <code>"type"</code> key in dict, initializes an instance using
<code>initSkimNoteWithBounds:</code>, and sets the known properties from dict.
Implementations in subclasses should call it on super and set their properties
from dict if available.
@param dict A dictionary with Skim notes properties, as returned from
properties. This is required to contain values for <code>"type"</code> and
<code>"bounds"</code>.
@@ -111,7 +108,6 @@
- (id)initSkimNoteWithProperties:(NSDictionary *)dict;
/*!
- @method
@abstract The Skim notes properties.
@discussion These properties can be used to initialize a new copy, and to
save to extended attributes or file.
@result A dictionary with properties of the Skim note. All values are
standard Cocoa objects conforming to <code>NSCoding</code> and
<code>NSCopying</code>.
@@ -119,7 +115,6 @@
- (NSDictionary *)SkimNoteProperties;
/*!
- @method
@abstract Returns whether the annotation is a Skim note.
@discussion An annotation initalized with initializers starting with
initSkimNote will return <code>YES</code> by default.
@result YES if the annotation is a Skim note; otherwise NO.
@@ -127,7 +122,6 @@
- (BOOL)isSkimNote;
/*!
- @method
@abstract Sets whether the receiver is to be interpreted as a Skim note.
@discussion You normally would not use this yourself, but rely on the
initializer to set the <code>isSkimNote</code> flag.
@param flag Set this value to <code>YES</code> if you want the
annotation to be interpreted as a Skim note.
@@ -135,7 +129,6 @@
- (void)setSkimNote:(BOOL)flag;
/*!
- @method
@abstract The string value of the annotation.
@discussion By default, this is just the same as the contents. However
for <code>SKNPDFAnnotationNote</code> the contents will contain both string and
text.
@result A string representing the string value associated with the
annotation.
@@ -143,7 +136,6 @@
- (NSString *)string;
/*!
- @method
@abstract Sets the string of the annotation. By default just sets the
contents.
@discussion By default just calls <code>setContent:</code>.
@param newString The new string value for the annotation.
@@ -155,7 +147,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a circle annotation.
*/
@@ -165,7 +156,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a square annotation.
*/
@@ -175,7 +165,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a line annotation.
*/
@@ -185,7 +174,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a free text annotation.
*/
@@ -195,7 +183,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a markup annotation.
*/
@@ -203,13 +190,11 @@
@end
/*!
- @category
@abstract An informal protocol providing a method name for an optional
method that may be implemented in a category.
@discussion This defines an optional method that another
<code>PDFAnnotationMarkup</code> category may implement to provide a default
color.
*/
@interface PDFAnnotationMarkup (SKNOptional)
/*!
- @method
@abstract Optional method to implement to return the default color to
use for markup initialized with properties that do not contain a color.
@param markupType The markup style for which to return the default
color.
@discussion This optional method can be implemented in another category to
provide a default color for Skim notes that have no color set in the properties
dictionary. This method is not implemented by default.
@@ -221,7 +206,6 @@
#pragma mark -
/*!
- @category
@abstract Provides methods to translate between dictionary
representations of Skim notes and <code>PDFAnnotation</code> objects.
@discussion Implements <code>initSkimNotesWithProperties:</code> and
properties to take care of the extra properties of a text annotation.
*/
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Skim-app-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/skim-app-commit
