Revision: 4119
http://skim-app.svn.sourceforge.net/skim-app/?rev=4119&view=rev
Author: hofman
Date: 2008-07-02 12:25:14 -0700 (Wed, 02 Jul 2008)
Log Message:
-----------
Extend documentation tags. Add target to project for building documentation.
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
trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj
Modified: trunk/SkimNotes/NSFileManager_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-02 17:53:53 UTC
(rev 4118)
+++ trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-02 19:25:14 UTC
(rev 4119)
@@ -36,129 +36,133 @@
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*!
+ @header NSFileManager_SKNExtensions.h
+ @discussion This file defines an NSFileManager category to read/write
Skim notes.
+*/
#import <Cocoa/Cocoa.h>
/*!
@category NSFileManager (SKNExtensions)
@abstract Provides methods to access Skim notes in extended attributes
or PDF bundles.
- @discussion (comprehensive description)
+ @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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or NULL if there was an error reading the
Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @discussion Reads the data from the extended attributes of the file and
unarchives it using NSKeyedUnarchiver.
+ @param aURL The URL for the file to read the text Skim notes from.
+ @param outError If there is an error reading the text Skim notes,
upon return contains an NSError object that describes the problem.
+ @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or NULL if there was an error reading the text
Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the RTF Skim notes, upon
return contains an NSError object that describes the problem.
+ @result NSData for an RTF representation of the Skim notes, an empty
NSData object if no RTF Skim notes were found, or NULL if there was an error
reading the RTF Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or NULL if there was an error reading the
Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the text Skim notes,
upon return contains an NSError object that describes the problem.
+ @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or NULL if there was an error reading the text
Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the RTF Skim notes, upon
return contains an NSError object that describes the problem.
+ @result NSData for an RTF representation of the Skim notes, an empty
NSData object if no RTF Skim notes were found, or NULL if there was an error
reading the RTF Skim notes.
*/
- (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 (comprehensive description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param outError If there is an error reading the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or NULL if there was an error reading the
Skim notes.
*/
- (NSArray *)readSkimNotesFromSkimFileAtURL:(NSURL *)aURL error:(NSError
**)outError;
/*!
@method writeSkimNotes:toExtendedAttributesAtURL:error:
- @abstract Calls
writeSkimNotes:textNotes:richTextNotes:toExtendedAttributesAtURL:error: with
nil notesString and notesRTFData.
- @discussion (comprehensive description)
- @param notes (description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @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
writeSkimNotes:textNotes:richTextNotes:toExtendedAttributesAtURL:error: with
nil notesString and notesRTFData.
+ @param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a PDFAnnotation.
+ @param aURL The URL for the file to write the Skim notes to.
+ @param outError If there is an error writing the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result Returns YES if writing out the Skim notes was successful;
otherwise returns NO.
*/
- (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 NSData using NSKeyedArchiver.
- @discussion (comprehensive description)
- @param notes (description)
- @param notesString (description)
- @param notesRTFData (description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @discussion This writes three types of Skim notes to the extended
attributes to the file located through aURL.
+ @param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a PDFAnnotation.
+ @param notesString A text representation of the Skim notes. When
NULL, a default representation will be generated from notes.
+ @param notesRTFData An RTF data representation of the Skim notes.
When NULL, a default representation will be generated from notes.
+ @param aURL The URL for the file to write the Skim notes to.
+ @param outError If there is an error writing the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result Returns YES if writing out the Skim notes was successful;
otherwise returns NO.
*/
- (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 (comprehensive description)
- @param notes (description)
- @param aURL (description)
- @param outError (description)
- @result (description)
+ @discussion Archives notes using NSKeyedArchiver and writes the data to
the file located by aURL.
+ @param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a PDFAnnotation.
+ @param aURL The URL for the .skim file to write the Skim notes to.
+ @param outError If there is an error writing the Skim notes, upon
return contains an NSError object that describes the problem.
+ @result Returns YES if writing out the Skim notes was successful;
otherwise returns NO.
*/
- (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 (comprehensive description)
- @param extension (description)
- @param path (description)
- @param outError (description)
- @result (description)
+ @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.
+ @param path The path to the PDF bundle.
+ @param outError If there is an error getting the bundled file, upon
return contains an NSError object that describes the problem.
+ @result A full path to the bundled file inside the PDF bundle, or NULL
if no bundled file was found.
*/
- (NSString *)bundledFileWithExtension:(NSString *)extension
inPDFBundleAtPath:(NSString *)path error:(NSError **)outError;
Modified: trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-02 17:53:53 UTC
(rev 4118)
+++ trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-02 19:25:14 UTC
(rev 4119)
@@ -36,6 +36,10 @@
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*!
+ @header PDFAnnotation_SKNExtensions.h
+ @discussion This file defines an PDFAnnotation categories to manage Skim
notes.
+*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
@@ -80,61 +84,68 @@
extern NSString *SKNPDFAnnotationIconTypeKey;
+/*!
+ @category PDFAnnotation (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Methods from this category are used by the PDFDocument
(SKNExtensions) category to add new annotations from Skim notes.
+*/
@interface PDFAnnotation (SKNExtensions)
/*!
@method initSkimNoteWithBounds:
- @abstract Initializes a new Skim note annotation .
- @discussion This is the designated intiializer for a SKim note.
- @param bounds (description)
- @result (description)
+ @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.
+ @result An initialized Skim note annotation instance, or NULL if the
object could not be initialized.
*/
- (id)initSkimNoteWithBounds:(NSRect)bounds;
/*!
@method initSkimNoteWithProperties:
@abstract Initializes a new Skim note annotation with the given
properties.
- @discussion (comprehensive description)
- @param bounds (description)
- @result (description)
+ @discussion This method determines the proper subclass from the value for
the "type" key in dict, initializes an instance using initSkimNoteWithBounds:,
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 "type" and "bounds".
+ @result An initialized Skim note annotation instance, or NULL if the
object could not be initialized.
*/
- (id)initSkimNoteWithProperties:(NSDictionary *)dict;
/*!
@method properties
- @abstract The Skim notes properties. These properties can be used to
initialize a new copy, and to save to extended attributes or file.
- @discussion (comprehensive description)
- @result (description)
+ @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 NSCoding and NSCopying.
*/
- (NSDictionary *)properties;
/*!
@method isSkimNote
- @abstract Returns whether the annotation is a Skim note. An annotation
initalized with initializers starting with initSkimNote will return YES by
default.
- @discussion (comprehensive description)
- @result (description)
+ @abstract Returns whether the annotation is a Skim note.
+ @discussion An annotation initalized with initializers starting with
initSkimNote will return YES by default.
+ @result YES if the annotation is a Skim note; otherwise NO.
*/
- (BOOL)isSkimNote;
/*!
@method setSkimNote:
- @abstract Sets whether the receiver is to be interpreted as a Skim note.
You normally would not use this yourself.
- @discussion (comprehensive description)
+ @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 isSkimNote flag.
+ @param flag Set this value to YES if you want the annotation to be
interpreted as a Skim note.
*/
- (void)setSkimNote:(BOOL)flag;
/*!
@method string
- @abstract The string value of the annotation. By default, this is just
the same as the contents. However for SKNPDFAnnotationNote the contents will
contain both string and text.
- @discussion (comprehensive description)
- @result (description)
+ @abstract The string value of the annotation.
+ @discussion By default, this is just the same as the contents. However
for SKNPDFAnnotationNote the contents will contain both string and text.
+ @result A string representing the string value associated with the
annotation.
*/
- (NSString *)string;
/*!
@method setString:
@abstract Sets the string of the annotation. By default just sets the
contents.
- @discussion (comprehensive description)
+ @discussion By default just calls setContent:.
+ @param newString The new string value for the annotation.
*/
- (void)setString:(NSString *)newString;
@@ -142,40 +153,76 @@
#pragma mark -
+/*!
+ @category PDFAnnotationCircle (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a circle annotation.
+*/
@interface PDFAnnotationCircle (SKNExtensions)
@end
#pragma mark -
+/*!
+ @category PDFAnnotationSquare (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a square annotation.
+*/
@interface PDFAnnotationSquare (SKNExtensions)
@end
#pragma mark -
+/*!
+ @category PDFAnnotationLine (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a line annotation.
+*/
@interface PDFAnnotationLine (SKNExtensions)
@end
#pragma mark -
+/*!
+ @category PDFAnnotationFreeText (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a free text annotation.
+*/
@interface PDFAnnotationFreeText (SKNExtensions)
@end
#pragma mark -
+/*!
+ @category PDFAnnotationMarkup (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a markup annotation.
+*/
@interface PDFAnnotationMarkup (SKNExtensions)
@end
+/*!
+ @category PDFAnnotationMarkup (SKNOptional)
+ @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
PDFAnnotationMarkup category may implement to provide a default color.
+*/
@interface PDFAnnotationMarkup (SKNOptional)
/*!
@method defaultColorForMarkupType:
- @abstract 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.
- @param markupType (description)
- @discussion This method is not implemented by default.
+ @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.
+ @result The default color for an annotation with the passed in markup
style.
*/
+ (NSColor *)defaultColorForMarkupType:(int)markupType;
@end
#pragma mark -
+/*!
+ @category PDFAnnotationText (SKNExtensions)
+ @abstract Provides methods to translate between dictionary
representations of Skim notes and PDFAnnotation objects.
+ @discussion Implements initSkimNotesWithProperties: and properties to
take care of the extra properties of a text annotation.
+*/
@interface PDFAnnotationText (SKNExtensions)
@end
Modified: trunk/SkimNotes/PDFDocument_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFDocument_SKNExtensions.h 2008-07-02 17:53:53 UTC (rev
4118)
+++ trunk/SkimNotes/PDFDocument_SKNExtensions.h 2008-07-02 19:25:14 UTC (rev
4119)
@@ -36,33 +36,37 @@
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*!
+ @header PDFDocument_SKNExtensions.h
+ @discussion This file defines an PDFDocument category to add Skim note
annotations to a PDFDocument.
+*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
/*!
@category PDFDocument (SKNExtensions)
- @abstract Provides methods to add Skim notes to a PDF document.
- @discussion (comprehensive description)
+ @abstract Provides methods to add Skim notes to a PDFDocument.
+ @discussion This category can be used to add Skim notes from their
properties to a PDFDocument or easily load a PDFDocument including attached
Skim notes.
*/
@interface PDFDocument (SKNExtensions)
/*!
@method initWithURL:readSkimNotes:
- @abstract Initializes a new PDF document 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
PDFAnnotations.
- @discussion (comprehensive description)
- @param url (description)
- @param notes (description)
- @result (description)
+ @abstract Initializes a new PDFDocument 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
PDFAnnotations.
+ @discussion Initializes a new PDFDocument using initWithURL:, reads Skim
notes from theextended attributes or the bundle, and adds new PDFAnnotation
objects to the document initialized by the found Skim note properties.
+ @param url The URL of the PDF file or PDF bundle.
+ @param notes An array of PDFAnnotation objects initialized using the
Skim note properties read from the extended attributes or bundled Skim file.
+ @result The initialized PDFDocument.
*/
- (id)initWithURL:(NSURL *)url readSkimNotes:(NSArray **)notes;
/*!
@method addSkimNotesWithProperties:
@abstract Adds new Skim notes from an array of property dictionaries to
the receiver, and returns the added Skim notes as an array of PDFAnnotations.
- @discussion (comprehensive description)
- @param noteDicts (description)
- @result (description)
+ @discussion This method initializes new PDFAnnotation objects from the
passed in properties and adds them to the appropriate pages of the PDFDocument.
+ @param noteDicts An array of dictionaries containing Skim note
properties as returned by the properties of PDFAnnotation objects.
+ @result An array of PDFAnnotation objects initialized using the Skim
note properties read from the extended attributes or bundled Skim file.
*/
- (NSArray *)addSkimNotesWithProperties:(NSArray *)noteDicts;
Modified: trunk/SkimNotes/SKNExtendedAttributeManager.h
===================================================================
--- trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-02 17:53:53 UTC
(rev 4118)
+++ trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-02 19:25:14 UTC
(rev 4119)
@@ -28,6 +28,10 @@
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
*/
+/*!
+ @header SKNExtendedAttributeManager.h
+ @discussion This file defines a singleton class to read and write
extended attributes in the format expected for Skim notes.
+*/
#import <Cocoa/Cocoa.h>
typedef UInt32 SKNXattrFlags;
Modified: trunk/SkimNotes/SKNPDFAnnotationNote.h
===================================================================
--- trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-02 17:53:53 UTC (rev
4118)
+++ trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-02 19:25:14 UTC (rev
4119)
@@ -36,6 +36,10 @@
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*!
+ @header SKNPDFAnnotationNote.h
+ @discussion This file defines a concrete PDFAnnotation class representing
a SKim anchored note.
+*/
#import <Cocoa/Cocoa.h>
#import <Quartz/Quartz.h>
@@ -44,6 +48,11 @@
extern NSSize SKNPDFAnnotationNoteSize;
+/*!
+ class SKNPDFAnnotationNote
+ @abstract A concrete PDFAnnotation subclass, a subclass of
PDFAnnotationText, representing a Skim anchored note.
+ @discussion This is a PDFAnnotationText subclass containing a separate
short string value, a longer rich text property, and an image property.
+*/
@interface SKNPDFAnnotationNote : PDFAnnotationText {
NSString *string;
NSImage *image;
@@ -55,50 +64,53 @@
/*!
@method string
@abstract This is overridden and different from the contents.
- @discussion (comprehensive description)
- @result (description)
+ @discussion This should give a short string value for the anchored note
annotation.
+ @result A string representing the string value associated with the
annotation.
*/
- (NSString *)string;
/*!
@method setString:
- @abstract This is overridden and different from the contents. This
calls updateContents.
- @discussion (comprehensive description)
+ @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 updateContents.
+ @param newString The new string value for the annotation.
*/
- (void)setString:(NSString *)newString;
/*!
@method text
@abstract The rich text of the annotation.
- @discussion (comprehensive description)
+ @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. This calls
updateContents.
- @discussion (comprehensive description)
+ @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 updateContents.
+ @param newText The new rich text value for the annotation.
*/
- (void)setText:(NSAttributedString *)newText;
/*!
@method image
@abstract The image of the annotation.
- @discussion (comprehensive description)
+ @discussion
*/
- (NSImage *)image;
/*!
@method setImage:
@abstract Sets the image of the annotation.
- @discussion (comprehensive description)
+ @discussion
+ @param newImage The new image for the annotation.
*/
- (void)setImage:(NSImage *)newImage;
/*!
@method updateContents
- @abstract Synchronizes the contents of the annotation with the string
and text. This sets the contents to the string and the text.
- @discussion (comprehensive description)
+ @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.
*/
- (void)updateContents;
Modified: trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj
===================================================================
--- trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj 2008-07-02 17:53:53 UTC
(rev 4118)
+++ trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj 2008-07-02 19:25:14 UTC
(rev 4119)
@@ -7,6 +7,17 @@
objects = {
/* Begin PBXAggregateTarget section */
+ CE665A840E1C086D00D0704D /* HeaderDocs */ = {
+ isa = PBXAggregateTarget;
+ buildConfigurationList = CE665A880E1C089700D0704D /*
Build configuration list for PBXAggregateTarget "HeaderDocs" */;
+ buildPhases = (
+ CE665A830E1C086D00D0704D /* ShellScript */,
+ );
+ dependencies = (
+ );
+ name = HeaderDocs;
+ productName = HeaderDocs;
+ };
CEBA2EA20E0673B60000B2E6 /* Archive */ = {
isa = PBXAggregateTarget;
buildConfigurationList = CEBA2EA70E0673F30000B2E6 /*
Build configuration list for PBXAggregateTarget "Archive" */;
@@ -178,7 +189,10 @@
CEBA2BD40E05826D0000B2E6 /*
NSFileManager_SKNExtensions.m */,
CEBA2BE00E0587EB0000B2E6 /*
PDFDocument_SKNExtensions.h */,
CEBA2BE10E0587EB0000B2E6 /*
PDFDocument_SKNExtensions.m */,
- CEBA2DD90E05A6FA0000B2E6 /* Annotations */,
+ CEBA2B6F0E0568430000B2E6 /*
PDFAnnotation_SKNExtensions.h */,
+ CEBA2B700E0568430000B2E6 /*
PDFAnnotation_SKNExtensions.m */,
+ CEBA2B8B0E0569010000B2E6 /*
SKNPDFAnnotationNote.h */,
+ CEBA2B8C0E0569010000B2E6 /*
SKNPDFAnnotationNote.m */,
);
name = "Framework Classes";
sourceTree = "<group>";
@@ -231,17 +245,6 @@
name = "Shared Classes";
sourceTree = "<group>";
};
- CEBA2DD90E05A6FA0000B2E6 /* Annotations */ = {
- isa = PBXGroup;
- children = (
- CEBA2B6F0E0568430000B2E6 /*
PDFAnnotation_SKNExtensions.h */,
- CEBA2B700E0568430000B2E6 /*
PDFAnnotation_SKNExtensions.m */,
- CEBA2B8B0E0569010000B2E6 /*
SKNPDFAnnotationNote.h */,
- CEBA2B8C0E0569010000B2E6 /*
SKNPDFAnnotationNote.m */,
- );
- name = Annotations;
- sourceTree = "<group>";
- };
CEBA30790E06DC4C0000B2E6 /* Configurations */ = {
isa = PBXGroup;
children = (
@@ -332,6 +335,7 @@
targets = (
8DC2EF4F0486A6940098B216 /* SkimNotes */,
CEBA2B540E0566B00000B2E6 /* skimnotes */,
+ CE665A840E1C086D00D0704D /* HeaderDocs */,
CEBA2EA20E0673B60000B2E6 /* Archive */,
);
};
@@ -349,6 +353,19 @@
/* End PBXResourcesBuildPhase section */
/* Begin PBXShellScriptBuildPhase section */
+ CE665A830E1C086D00D0704D /* ShellScript */ = {
+ isa = PBXShellScriptBuildPhase;
+ buildActionMask = 2147483647;
+ files = (
+ );
+ inputPaths = (
+ );
+ outputPaths = (
+ );
+ runOnlyForDeploymentPostprocessing = 0;
+ shellPath = /bin/sh;
+ shellScript = "/usr/bin/gatherheaderdoc
$TARGET_BUILD_DIR/SkimNotes\\ Documentation\n/usr/bin/headerdoc2html -o
$TARGET_BUILD_DIR/SkimNotes\\ Documentation $SRCROOT/*.h\nexit 0";
+ };
CEBA2EA10E0673B60000B2E6 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
buildActionMask = 2147483647;
@@ -492,6 +509,27 @@
};
name = Release;
};
+ CE665A860E1C086F00D0704D /* Debug */ = {
+ isa = XCBuildConfiguration;
+ buildSettings = {
+ COPY_PHASE_STRIP = NO;
+ GCC_DYNAMIC_NO_PIC = NO;
+ GCC_OPTIMIZATION_LEVEL = 0;
+ PRODUCT_NAME = HeaderDocs;
+ };
+ name = Debug;
+ };
+ CE665A870E1C086F00D0704D /* Release */ = {
+ isa = XCBuildConfiguration;
+ buildSettings = {
+ COPY_PHASE_STRIP = YES;
+ DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
+ GCC_ENABLE_FIX_AND_CONTINUE = NO;
+ PRODUCT_NAME = HeaderDocs;
+ ZERO_LINK = NO;
+ };
+ name = Release;
+ };
CEBA2B570E0566B30000B2E6 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
@@ -573,6 +611,15 @@
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
+ CE665A880E1C089700D0704D /* Build configuration list for
PBXAggregateTarget "HeaderDocs" */ = {
+ isa = XCConfigurationList;
+ buildConfigurations = (
+ CE665A860E1C086F00D0704D /* Debug */,
+ CE665A870E1C086F00D0704D /* Release */,
+ );
+ defaultConfigurationIsVisible = 0;
+ defaultConfigurationName = Release;
+ };
CEBA2B600E0566DF0000B2E6 /* Build configuration list for
PBXNativeTarget "skimnotes" */ = {
isa = XCConfigurationList;
buildConfigurations = (
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
Studies have shown that voting for your favorite open source project,
along with a healthy diet, reduces your potential for chronic lameness
and boredom. Vote Now at http://www.sourceforge.net/community/cca08
_______________________________________________
Skim-app-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/skim-app-commit
