Revision: 4226
http://skim-app.svn.sourceforge.net/skim-app/?rev=4226&view=rev
Author: hofman
Date: 2008-07-15 14:07:49 -0700 (Tue, 15 Jul 2008)
Log Message:
-----------
Remove unnecessary headerdoc tags.
Modified Paths:
--------------
trunk/SkimNotes/NSFileManager_SKNExtensions.h
trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
trunk/SkimNotes/PDFDocument_SKNExtensions.h
trunk/SkimNotes/SKNExtendedAttributeManager.h
trunk/SkimNotes/SKNPDFAnnotationNote.h
Modified: trunk/SkimNotes/NSFileManager_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-15 19:00:13 UTC
(rev 4225)
+++ trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-15 21:07:49 UTC
(rev 4226)
@@ -38,20 +38,19 @@
/*!
@header
- @discussion This file defines an <code>NSFileManager</code> category to
read/write Skim notes.
+ @abstract An <code>NSFileManager</code> category to read and write Skim
notes.
+ @discussion This header file provides API for an
<code>NSFileManager</code> category to read and write Skim notes.
*/
#import <Cocoa/Cocoa.h>
/*!
- @category NSFileManager(SKNExtensions)
@abstract Provides methods to access Skim notes in extended attributes
or PDF bundles.
@discussion This category is the main interface to read and write Skim
notes from and to files and extended attributes of files.
*/
@interface NSFileManager (SKNExtensions)
/*!
- @method readSkimNotesFromExtendedAttributesAtURL:error:
@abstract Reads Skim notes as an array of property dictionaries from the
extended attributes of a file.
@discussion Reads the data from the extended attributes of the file and
convert.
@param aURL The URL for the file to read the Skim notes from.
@@ -61,7 +60,6 @@
- (NSArray *)readSkimNotesFromExtendedAttributesAtURL:(NSURL *)aURL
error:(NSError **)outError;
/*!
- @method readSkimTextNotesFromExtendedAttributesAtURL:error:
@abstract Reads text Skim notes as a string from the extended attributes
of a file.
@discussion Reads the data from the extended attributes of the file and
unarchives it using <code>NSKeyedUnarchiver</code>.
@param aURL The URL for the file to read the text Skim notes from.
@@ -71,7 +69,6 @@
- (NSString *)readSkimTextNotesFromExtendedAttributesAtURL:(NSURL *)aURL
error:(NSError **)outError;
/*!
- @method readSkimRTFNotesFromExtendedAttributesAtURL:error:
@abstract Reads rich text Skim notes as RTF data from the extended
attributes of a file.
@discussion Reads the data from the extended attributes of the file.
@param aURL The URL for the file to read the RTF Skim notes from.
@@ -81,7 +78,6 @@
- (NSData *)readSkimRTFNotesFromExtendedAttributesAtURL:(NSURL *)aURL
error:(NSError **)outError;
/*!
- @method readSkimNotesFromPDFBundleAtURL:error:
@abstract Reads Skim notes as an array of property dictionaries from the
contents of a PDF bundle.
@discussion Reads the data from a bundled file in the PDF bundle with the
proper .skim extension.
@param aURL The URL for the PDF bundle to read the Skim notes from.
@@ -91,7 +87,6 @@
- (NSArray *)readSkimNotesFromPDFBundleAtURL:(NSURL *)aURL error:(NSError
**)outError;
/*!
- @method readSkimTextNotesFromPDFBundleAtURL:error:
@abstract Reads text Skim notes as a string from the contents of a PDF
bundle.
@discussion Reads the data from a bundled file in the PDF bundle with the
proper .txt extension.
@param aURL The URL for the PDF bundle to read the text Skim notes
from.
@@ -101,7 +96,6 @@
- (NSString *)readSkimTextNotesFromPDFBundleAtURL:(NSURL *)aURL error:(NSError
**)outError;
/*!
- @method readSkimRTFNotesFromPDFBundleAtURL:error:
@abstract Reads rich text Skim notes as RTF data from the contents of a
PDF bundle.
@discussion Reads the data from a bundled file in the PDF bundle with the
proper .rtf extension.
@param aURL The URL for the PDF bundle to read the RTF Skim notes
from.
@@ -111,7 +105,6 @@
- (NSData *)readSkimRTFNotesFromPDFBundleAtURL:(NSURL *)aURL error:(NSError
**)outError;
/*!
- @method readSkimNotesFromSkimFileAtURL:error:
@abstract Reads Skim notes as an array of property dictionaries from the
contents of a .skim file.
@discussion Reads data from the file and unarchives it using
NSKeyedUnarchiver.
@param aURL The URL for the .skim file to read the Skim notes from.
@@ -121,7 +114,6 @@
- (NSArray *)readSkimNotesFromSkimFileAtURL:(NSURL *)aURL error:(NSError
**)outError;
/*!
- @method writeSkimNotes:toExtendedAttributesAtURL:error:
@abstract Writes Skim notes passed as an array of property dictionaries
to the extended attributes of a file, as well as a defaultrepresentation for
text Skim notes and RTF Skim notes.
@discussion Calls
<code>writeSkimNotes:textNotes:richTextNotes:toExtendedAttributesAtURL:error:</code>
with nil <code>notesString</code> and <code>notesRTFData</code>.
@param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a PDFAnnotation.
@@ -132,7 +124,6 @@
- (BOOL)writeSkimNotes:(NSArray *)notes toExtendedAttributesAtURL:(NSURL
*)aURL error:(NSError **)outError;
/*!
- @method
writeSkimNotes:textNotes:richTextNotes:toExtendedAttributesAtURL:error:
@abstract Writes Skim notes passed as an array of property dictionaries
to the extended attributes of a file, as well as text Skim notes and RTF Skim
notes. The array is converted to <code>NSData</code> using
<code>NSKeyedArchiver</code>.
@discussion This writes three types of Skim notes to the extended
attributes to the file located through <code>aURL</code>.
@param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a <code>PDFAnnotation</code>.
@@ -145,7 +136,6 @@
- (BOOL)writeSkimNotes:(NSArray *)notes textNotes:(NSString *)notesString
richTextNotes:(NSData *)notesRTFData toExtendedAttributesAtURL:(NSURL *)aURL
error:(NSError **)outError;
/*!
- @method writeSkimNotes:toSkimFileAtURL:error:
@abstract Writes Skim notes passed as an array of property dictionaries
to a .skim file.
@discussion Archives notes using NSKeyedArchiver and writes the data to
the file located by <code>aURL</code>.
@param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a <code>PDFAnnotation</code>.
@@ -156,7 +146,6 @@
- (BOOL)writeSkimNotes:(NSArray *)notes toSkimFileAtURL:(NSURL *)aURL
error:(NSError **)outError;
/*!
- @method bundledFileWithExtension:inPDFBundleAtPath:error:
@abstract Returns the full path for the file of a given type inside a
PDF bundle.
@discussion If more than one bundled files with the given extension exist
in the PDF bundle, this will follow the naming rules followed by Skim to find
the best match.
@param extension The file extension for which to find a bundled file.
Modified: trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-15 19:00:13 UTC
(rev 4225)
+++ trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-15 21:07:49 UTC
(rev 4226)
@@ -38,7 +38,8 @@
/*!
@header
- @discussion This file defines an <code>PDFAnnotation</code> categories to
manage Skim notes.
+ @abstract An <code>PDFAnnotation</code> category to manage Skim notes.
+ @discussion This header file provides API for an
<code>PDFAnnotation</code> categories to convert Skim note dictionaries to
<code>PDFAnnotations</code> and back.
*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
@@ -85,14 +86,14 @@
/*!
- @category PDFAnnotation(SKNExtensions)
+ @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 initSkimNoteWithBounds:
+ @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.
@@ -101,7 +102,7 @@
- (id)initSkimNoteWithBounds:(NSRect)bounds;
/*!
- @method initSkimNoteWithProperties:
+ @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>.
@@ -110,7 +111,7 @@
- (id)initSkimNoteWithProperties:(NSDictionary *)dict;
/*!
- @method SkimNoteProperties
+ @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>.
@@ -118,7 +119,7 @@
- (NSDictionary *)SkimNoteProperties;
/*!
- @method isSkimNote
+ @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.
@@ -126,7 +127,7 @@
- (BOOL)isSkimNote;
/*!
- @method setSkimNote:
+ @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.
@@ -134,7 +135,7 @@
- (void)setSkimNote:(BOOL)flag;
/*!
- @method string
+ @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.
@@ -142,7 +143,7 @@
- (NSString *)string;
/*!
- @method setString:
+ @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.
@@ -154,7 +155,7 @@
#pragma mark -
/*!
- @category PDFAnnotationCircle(SKNExtensions)
+ @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.
*/
@@ -164,7 +165,7 @@
#pragma mark -
/*!
- @category PDFAnnotationSquare(SKNExtensions)
+ @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.
*/
@@ -174,7 +175,7 @@
#pragma mark -
/*!
- @category PDFAnnotationLine(SKNExtensions)
+ @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.
*/
@@ -184,7 +185,7 @@
#pragma mark -
/*!
- @category PDFAnnotationFreeText(SKNExtensions)
+ @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.
*/
@@ -194,7 +195,7 @@
#pragma mark -
/*!
- @category PDFAnnotationMarkup(SKNExtensions)
+ @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.
*/
@@ -202,13 +203,13 @@
@end
/*!
- @category PDFAnnotationMarkup(SKNOptional)
+ @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 defaultSkimNoteColorForMarkupType:
+ @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.
@@ -220,7 +221,7 @@
#pragma mark -
/*!
- @category PDFAnnotationText(SKNExtensions)
+ @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.
*/
Modified: trunk/SkimNotes/PDFDocument_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFDocument_SKNExtensions.h 2008-07-15 19:00:13 UTC (rev
4225)
+++ trunk/SkimNotes/PDFDocument_SKNExtensions.h 2008-07-15 21:07:49 UTC (rev
4226)
@@ -38,21 +38,22 @@
/*!
@header
- @discussion This file defines an <code>PDFDocument</code> category to add
Skim note annotations to a <code>PDFDocument</code>.
+ @abstract An <code>PDFDocument</code> category to add Skim note
annotations to a <code>PDFDocument</code>.
+ @discussion This header file provides API for an <code>PDFDocument</code>
category to add Skim note annotations to a <code>PDFDocument</code>.
*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
/*!
- @category PDFDocument(SKNExtensions)
+ @category
@abstract Provides methods to add Skim notes to a
<code>PDFDocument</code>.
@discussion This category can be used to add Skim notes from their
properties to a <code>PDFDocument</code> or easily load a
<code>PDFDocument</code> including attached Skim notes.
*/
@interface PDFDocument (SKNExtensions)
/*!
- @method initWithURL:readSkimNotes:
+ @method
@abstract Initializes a new <code>PDFDocument</code> from a file or PDF
bundle, adding Skim notes from the extended attributes of the file or the
contents of the PDF bundle. The added Skim notes are returned by reference as
an array of <code>PDFAnnotation</code>s.
@discussion Initializes a new <code>PDFDocument</code> using
<code>initWithURL:</code>, reads Skim notes from theextended attributes or the
bundle, and adds new <code>PDFAnnotation</code> objects to the document
initialized by the found Skim note properties.
@param url The URL of the PDF file or PDF bundle.
@@ -62,7 +63,7 @@
- (id)initWithURL:(NSURL *)url readSkimNotes:(NSArray **)notes;
/*!
- @method addSkimNotesWithProperties:
+ @method
@abstract Adds new Skim notes from an array of property dictionaries to
the receiver, and returns the added Skim notes as an array of
<code>PDFAnnotations</code>.
@discussion This method initializes new <code>PDFAnnotation</code> objects
from the passed in properties and adds them to the appropriate pages of the
<code>PDFDocument</code>.
@param noteDicts An array of dictionaries containing Skim note
properties as returned by the properties of <code>PDFAnnotation</code> objects.
Modified: trunk/SkimNotes/SKNExtendedAttributeManager.h
===================================================================
--- trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-15 19:00:13 UTC
(rev 4225)
+++ trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-15 21:07:49 UTC
(rev 4226)
@@ -30,7 +30,8 @@
/*!
@header
- @discussion This file defines a singleton class to read and write
extended attributes in the format expected for Skim notes.
+ @abstract An singleton class to read and write extended attributes.
+ @discussion This header file declares API for a singleton class to read
and write extended attributes in the format expected for Skim notes.
*/
#import <Cocoa/Cocoa.h>
@@ -55,7 +56,6 @@
/*!
- @class SKNExtendedAttributeManager
@abstract Provides an Objective-C wrapper for the low-level BSD
functions dealing with file attributes.
@discussion This class is the core object to read and write extended
attributes, which are used to store Skim notes with PDF files.
*/
@@ -67,7 +67,6 @@
}
/*!
- @method sharedManager
@abstract Returns the shared instance. You probably always should use
this instance, and is required for Skim notes.
@discussion This shared manager uses the default prefix and is used for
reading and writing Skim notes to PDF files. It may split attributes into
fragments if the data is too long.
@result The default shared EA manager used for Skim notes.
@@ -75,7 +74,6 @@
+ (id)sharedManager;
/*!
- @method sharedNoSplitManager
@abstract Returns a shared instance with nil prefix. This instance
never splits attributes, and can also not reassemble splitted attributes.
@discussion This manager never splits attributes into fragments. Settting
attributes is always as if <code>kSKNXattrNoSplitData</code> is passed. Also
when reading it will not be able to reassemble split attributes.
However attributes that were set using this manager will be
readable also by managers with different prefixes, such as the
<code>sharedManager</code>.
@@ -84,7 +82,6 @@
+ (id)sharedNoSplitManager;
/*!
- @method initWithPrefix:
@abstract Initializes a new extended attribute manager with keys and
attribute name prefixes used for segments determined by a prefix.
@discussion The prefix is used in splitting large attributes. EA managers
with different prefixes are mutually incompatible,
i.e. attributes written with one manager cannot be safely read
by a manager with a different prefix.
@@ -96,7 +93,6 @@
- (id)initWithPrefix:(NSString *)prefix;
/*!
- @method extendedAttributeNamesAtPath:traverseLink:
@abstract Return a list of extended attributes for the given file.
@discussion Calls <code>listxattr(2)</code> to determine all of the
extended attributes, and returns them as
an array of <code>NSString</code> objects. Returns
<code>nil</code> if an error occurs. Does not return attribute names for
fragments.
@@ -108,7 +104,6 @@
- (NSArray *)extendedAttributeNamesAtPath:(NSString *)path
traverseLink:(BOOL)follow error:(NSError **)error;
/*!
- @method extendedAttributeNamed:atPath:traverseLink:error:
@abstract Return the extended attribute named <code>attr</code> for a
given file.
@discussion Calls <code>getxattr(2)</code> to determine the extended
attribute, and returns it as data.
@param attr The attribute name.
@@ -120,7 +115,6 @@
- (NSData *)extendedAttributeNamed:(NSString *)attr atPath:(NSString *)path
traverseLink:(BOOL)follow error:(NSError **)error;
/*!
- @method allExtendedAttributesAtPath:traverseLink:error:
@abstract Returns all extended attributes for the given file, each as an
<code>NSData</code> object.
@discussion Calls
<code>extendedAttributeNamesAtPath:traverseLink:error:</code> to find all
attribute names and then calls
<code>extendedAttributeNamed:atPath:traverseLink:error:</code> repreatedly for
all attribute names.
@param path Path to the object in the file system.
@@ -131,7 +125,6 @@
- (NSDictionary *)allExtendedAttributesAtPath:(NSString *)path
traverseLink:(BOOL)follow error:(NSError **)error;
/*!
- @method
propertyListFromExtendedAttributeNamed:atPath:traverseLink:error:
@abstract Returns a property list using NSPropertyListSerialization.
@discussion (comprehensive description)
@param attr The attribute name.
@@ -143,7 +136,6 @@
- (id)propertyListFromExtendedAttributeNamed:(NSString *)attr atPath:(NSString
*)path traverseLink:(BOOL)follow error:(NSError **)error;
/*!
- @method setExtendedAttributeNamed:toValue:atPath:options:error:
@abstract Sets the value of attribute named <code>attr</code> to
<code>value</code>, which is an <code>NSData</code> object.
@discussion Calls <code>setxattr(2)</code> to set the attributes for the
file.
If the options do not contain the
<code>kSKNXattrNoSplitData</code> flag and the prefix is not <code>nil</code>,
the data may be split into subfragments and a dictionary pointing to the
fragments is saved in the attribute names <code>attr</code>.
@@ -157,7 +149,6 @@
- (BOOL)setExtendedAttributeNamed:(NSString *)attr toValue:(NSData *)value
atPath:(NSString *)path options:(SKNXattrFlags)options error:(NSError **)error;
/*!
- @method
setExtendedAttributeNamed:toPropertyListValue:atPath:options:error:
@abstract Sets the extended attribute named <code>attr</code> to the
specified property list.
@discussion The plist is converted to <code>NSData</code> using
<code>NSPropertyListSerialization</code> and set using
<code>setExtendedAttributeNamed:toValue:atPath:options:error:</code>.
For the non-split manager without prefix, the data may be
compressed using <code>bzip2</code> when the archived data is too large.
@@ -171,7 +162,6 @@
- (BOOL)setExtendedAttributeNamed:(NSString *)attr
toPropertyListValue:(id)plist atPath:(NSString *)path
options:(SKNXattrFlags)options error:(NSError **)error;
/*!
- @method removeExtendedAttribute:atPath:followLinks:error:
@abstract Removes the given attribute <code>attr</code> from the named
file at <code>path</code>.
@discussion Calls <code>removexattr(2)</code> to remove the given
attribute from the file.
@param attr The attribute name.
@@ -183,7 +173,6 @@
- (BOOL)removeExtendedAttribute:(NSString *)attr atPath:(NSString *)path
traverseLink:(BOOL)follow error:(NSError **)error;
/*!
- @method removeAllExtendedAttributesAtPath:traverseLink:error:
@abstract Removes all extended attributes at the specified path.
@discussion Calls <code>removexattr(2)</code> repeatedly to remove all
attributes from the file.
@param path Path to the object in the file system.
Modified: trunk/SkimNotes/SKNPDFAnnotationNote.h
===================================================================
--- trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-15 19:00:13 UTC (rev
4225)
+++ trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-15 21:07:49 UTC (rev
4226)
@@ -38,7 +38,8 @@
/*!
@header
- @discussion This file defines a concrete <code>PDFAnnotation</code> class
representing a SKim anchored note.
+ @abstract A concrete <code>PDFAnnotation</code> subclass representing a
Skim anchored note.
+ @discussion This header file declares API for a concrete
<code>PDFAnnotation</code> class representing a Skim anchored note.
*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
@@ -49,7 +50,6 @@
extern NSSize SKNPDFAnnotationNoteSize;
/*!
- class SKNPDFAnnotationNote
@abstract A concrete <code>PDFAnnotation</code> subclass, a subclass of
<code>PDFAnnotationText</code>, representing a Skim anchored note.
@discussion This is a <code>PDFAnnotationText</code> subclass containing
a separate short string value, a longer rich text property, and an image
property.
*/
@@ -62,7 +62,6 @@
}
/*!
- @method string
@abstract This is overridden and different from the contents.
@discussion This should give a short string value for the anchored note
annotation.
@result A string representing the string value associated with the
annotation.
@@ -70,7 +69,6 @@
- (NSString *)string;
/*!
- @method setString:
@abstract This is overridden and different from the contents.
@discussion This should set the short string value of the annotation.
This updates the contents using <code>updateContents</code>.
@param newString The new string value for the annotation.
@@ -78,14 +76,12 @@
- (void)setString:(NSString *)newString;
/*!
- @method text
@abstract The rich text of the annotation.
@discussion This is the longer rich text contents of the anchored note
annotation.
*/
- (NSAttributedString *)text;
/*!
- @method setText:
@abstract Sets the rich text of the annotation.
@discussion This should set the longer rich text contents of the
annotation. This updates the contents using <code>updateContents</code>.
@param newText The new rich text value for the annotation.
@@ -93,14 +89,12 @@
- (void)setText:(NSAttributedString *)newText;
/*!
- @method image
@abstract The image of the annotation.
@discussion
*/
- (NSImage *)image;
/*!
- @method setImage:
@abstract Sets the image of the annotation.
@discussion
@param newImage The new image for the annotation.
@@ -108,7 +102,6 @@
- (void)setImage:(NSImage *)newImage;
/*!
- @method updateContents
@abstract Synchronizes the contents of the annotation with the string
and text.
@discussion This sets the contents to the string value and the text
appended, separated by a double space.
*/
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
