Revision: 4225
http://skim-app.svn.sourceforge.net/skim-app/?rev=4225&view=rev
Author: hofman
Date: 2008-07-15 12:00:13 -0700 (Tue, 15 Jul 2008)
Log Message:
-----------
Improve documentation and add documentation to archive.
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
Added Paths:
-----------
trunk/SkimNotes/SkimNotes.hdoc
Modified: trunk/SkimNotes/NSFileManager_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-15 15:18:42 UTC
(rev 4224)
+++ trunk/SkimNotes/NSFileManager_SKNExtensions.h 2008-07-15 19:00:13 UTC
(rev 4225)
@@ -37,14 +37,14 @@
*/
/*!
- @header NSFileManager_SKNExtensions.h
+ @header
@discussion This file defines an <code>NSFileManager</code> category to
read/write Skim notes.
*/
#import <Cocoa/Cocoa.h>
/*!
- @category NSFileManager (SKNExtensions)
+ @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.
*/
Modified: trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-15 15:18:42 UTC
(rev 4224)
+++ trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2008-07-15 19:00:13 UTC
(rev 4225)
@@ -37,7 +37,7 @@
*/
/*!
- @header PDFAnnotation_SKNExtensions.h
+ @header
@discussion This file defines an <code>PDFAnnotation</code> categories to
manage Skim notes.
*/
#import <Cocoa/Cocoa.h>
@@ -85,7 +85,7 @@
/*!
- @category PDFAnnotation (SKNExtensions)
+ @category PDFAnnotation(SKNExtensions)
@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.
*/
@@ -154,7 +154,7 @@
#pragma mark -
/*!
- @category PDFAnnotationCircle (SKNExtensions)
+ @category PDFAnnotationCircle(SKNExtensions)
@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 +164,7 @@
#pragma mark -
/*!
- @category PDFAnnotationSquare (SKNExtensions)
+ @category PDFAnnotationSquare(SKNExtensions)
@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 +174,7 @@
#pragma mark -
/*!
- @category PDFAnnotationLine (SKNExtensions)
+ @category PDFAnnotationLine(SKNExtensions)
@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 +184,7 @@
#pragma mark -
/*!
- @category PDFAnnotationFreeText (SKNExtensions)
+ @category PDFAnnotationFreeText(SKNExtensions)
@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 +194,7 @@
#pragma mark -
/*!
- @category PDFAnnotationMarkup (SKNExtensions)
+ @category PDFAnnotationMarkup(SKNExtensions)
@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,7 +202,7 @@
@end
/*!
- @category PDFAnnotationMarkup (SKNOptional)
+ @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
<code>PDFAnnotationMarkup</code> category may implement to provide a default
color.
*/
@@ -220,7 +220,7 @@
#pragma mark -
/*!
- @category PDFAnnotationText (SKNExtensions)
+ @category PDFAnnotationText(SKNExtensions)
@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 15:18:42 UTC (rev
4224)
+++ trunk/SkimNotes/PDFDocument_SKNExtensions.h 2008-07-15 19:00:13 UTC (rev
4225)
@@ -37,7 +37,7 @@
*/
/*!
- @header PDFDocument_SKNExtensions.h
+ @header
@discussion This file defines an <code>PDFDocument</code> category to add
Skim note annotations to a <code>PDFDocument</code>.
*/
#import <Cocoa/Cocoa.h>
@@ -45,7 +45,7 @@
/*!
- @category PDFDocument (SKNExtensions)
+ @category PDFDocument(SKNExtensions)
@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.
*/
Modified: trunk/SkimNotes/SKNExtendedAttributeManager.h
===================================================================
--- trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-15 15:18:42 UTC
(rev 4224)
+++ trunk/SkimNotes/SKNExtendedAttributeManager.h 2008-07-15 19:00:13 UTC
(rev 4225)
@@ -29,7 +29,7 @@
*/
/*!
- @header SKNExtendedAttributeManager.h
+ @header
@discussion This file defines a singleton class to read and write
extended attributes in the format expected for Skim notes.
*/
#import <Cocoa/Cocoa.h>
Modified: trunk/SkimNotes/SKNPDFAnnotationNote.h
===================================================================
--- trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-15 15:18:42 UTC (rev
4224)
+++ trunk/SkimNotes/SKNPDFAnnotationNote.h 2008-07-15 19:00:13 UTC (rev
4225)
@@ -37,7 +37,7 @@
*/
/*!
- @header SKNPDFAnnotationNote.h
+ @header
@discussion This file defines a concrete <code>PDFAnnotation</code> class
representing a SKim anchored note.
*/
#import <Cocoa/Cocoa.h>
Added: trunk/SkimNotes/SkimNotes.hdoc
===================================================================
--- trunk/SkimNotes/SkimNotes.hdoc (rev 0)
+++ trunk/SkimNotes/SkimNotes.hdoc 2008-07-15 19:00:13 UTC (rev 4225)
@@ -0,0 +1,5 @@
+/*!
+ @framework SkimNotes Framework
+ @abstract Framework to read and write Skim notes.
+ @discussion The SkimNotes framework defines an Objective-C API to read and
write Skim notes.
+*/
Modified: trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj
===================================================================
--- trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj 2008-07-15 15:18:42 UTC
(rev 4224)
+++ trunk/SkimNotes/SkimNotes.xcodeproj/project.pbxproj 2008-07-15 19:00:13 UTC
(rev 4225)
@@ -26,7 +26,9 @@
);
dependencies = (
CEBA2EA60E0673D40000B2E6 /* PBXTargetDependency
*/,
+ CEA5F5B00E2CF8B100F65088 /* PBXTargetDependency
*/,
CEBA2EAC0E067F420000B2E6 /* PBXTargetDependency
*/,
+ CEA5F6090E2D270500F65088 /* PBXTargetDependency
*/,
);
name = Archive;
productName = Archive;
@@ -65,6 +67,20 @@
/* End PBXBuildFile section */
/* Begin PBXContainerItemProxy section */
+ CEA5F5AF0E2CF8B100F65088 /* PBXContainerItemProxy */ = {
+ isa = PBXContainerItemProxy;
+ containerPortal = 0867D690FE84028FC02AAC07 /* Project
object */;
+ proxyType = 1;
+ remoteGlobalIDString = CEA5F53C0E2CED0E00F65088;
+ remoteInfo = SkimNotesBase;
+ };
+ CEA5F6080E2D270500F65088 /* PBXContainerItemProxy */ = {
+ isa = PBXContainerItemProxy;
+ containerPortal = 0867D690FE84028FC02AAC07 /* Project
object */;
+ proxyType = 1;
+ remoteGlobalIDString = CE665A840E1C086D00D0704D;
+ remoteInfo = HeaderDocs;
+ };
CEBA2EA50E0673D40000B2E6 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 0867D690FE84028FC02AAC07 /* Project
object */;
@@ -107,6 +123,7 @@
CEA5F5490E2CED6D00F65088 /* SkimNotesBase.h */ = {isa =
PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path =
SkimNotesBase.h; sourceTree = "<group>"; };
CEA5F54C0E2CEDC400F65088 /* SkimNotesBase_Prefix.pch */ = {isa
= PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path
= SkimNotesBase_Prefix.pch; sourceTree = "<group>"; };
CEA5F5870E2CF63000F65088 /* SKNCompatibility.h */ = {isa =
PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path =
SKNCompatibility.h; sourceTree = "<group>"; };
+ CEA5F5E40E2D0FDB00F65088 /* SkimNotes.hdoc */ = {isa =
PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path =
SkimNotes.hdoc; sourceTree = "<group>"; };
CEBA2B550E0566B00000B2E6 /* skimnotes */ = {isa =
PBXFileReference; explicitFileType = "compiled.mach-o.executable";
includeInIndex = 0; path = skimnotes; sourceTree = BUILT_PRODUCTS_DIR; };
CEBA2B5A0E0566DF0000B2E6 /* SKNAgentListener.h */ = {isa =
PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path =
SKNAgentListener.h; sourceTree = "<group>"; };
CEBA2B5B0E0566DF0000B2E6 /* SKNAgentListener.m */ = {isa =
PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path
= SKNAgentListener.m; sourceTree = "<group>"; };
@@ -166,8 +183,8 @@
isa = PBXGroup;
children = (
8DC2EF5B0486A6940098B216 /* SkimNotes.framework
*/,
+ CEA5F53D0E2CED0E00F65088 /*
SkimNotesBase.framework */,
CEBA2B550E0566B00000B2E6 /* skimnotes */,
- CEA5F53D0E2CED0E00F65088 /*
SkimNotesBase.framework */,
);
name = Products;
sourceTree = "<group>";
@@ -251,6 +268,7 @@
CEA5F54C0E2CEDC400F65088 /*
SkimNotesBase_Prefix.pch */,
CE17F1BB0E25861700DE06EA /*
SkimNotes_Tool_Prefix.pch */,
CEA5F5870E2CF63000F65088 /* SKNCompatibility.h
*/,
+ CEA5F5E40E2D0FDB00F65088 /* SkimNotes.hdoc */,
);
name = "Other Sources";
sourceTree = "<group>";
@@ -429,12 +447,19 @@
files = (
);
inputPaths = (
+ "$(SRCROOT)/SkimNotes.hdoc",
+ "$(SRCROOT)/SKNExtendedAttributeManager.h",
+ "$(SRCROOT)/NSFileManager_SKNExtensions.h",
+ "$(SRCROOT)/PDFDocument_SKNExtensions.h",
+ "$(SRCROOT)/PDFAnnotation_SKNExtensions.h",
+ "$(SRCROOT)/SKNPDFAnnotationNote.h",
);
outputPaths = (
+ "$(TARGET_BUILD_DIR)/SkimNotes Documentation",
);
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";
+ shellScript = "/usr/bin/headerdoc2html -o
$TARGET_BUILD_DIR/SkimNotes\\ Documentation
$SRCROOT/*.{hdoc,h}\n/usr/bin/gatherheaderdoc $TARGET_BUILD_DIR/SkimNotes\\
Documentation\nexit 0";
};
CEBA2EA10E0673B60000B2E6 /* ShellScript */ = {
isa = PBXShellScriptBuildPhase;
@@ -447,7 +472,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
- shellScript = "tmpdir=`/usr/bin/mktemp -d
/tmp/net.sourceforge.skim-app.skimnotes.XXXX`\nbasedir=\"SkimNotes\"\nsourcedir=\"${basedir}/Source\"\ncd
\"${tmpdir}\"\n/bin/mkdir \"${basedir}\"\n/bin/mkdir \"${sourcedir}\"\n/bin/cp
-Rf \"${SOURCE_ROOT}\"/* \"${sourcedir}\"\n/bin/cp -Rf
\"${BUILT_PRODUCTS_DIR}\"/{skimnotes,SkimNotes.framework}
\"${basedir}\"\n/bin/cp -f \"${SOURCE_ROOT}\"/{Licence.txt,SkimNotes.rtf}
\"${basedir}\"\n/usr/bin/find \"${basedir}\" -type f \\( -name \".DS_Store\"
-or -name \"*.pbxuser\" -or -name \"*.mode*\" \\) -delete\n/usr/bin/find
\"${basedir}\" -type d -name \".svn\" -delete\n/usr/bin/tar czf
\"${HOME}/Desktop/SkimNotes.tgz\" \"${basedir}\"\n/bin/rm -rf
\"${tmpdir}\"\nexit 0";
+ shellScript = "tmpdir=`/usr/bin/mktemp -d
/tmp/net.sourceforge.skim-app.skimnotes.XXXX`\nbasedir=\"SkimNotes\"\nsourcedir=\"${basedir}/Source\"\ncd
\"${tmpdir}\"\n/bin/mkdir \"${basedir}\"\n/bin/mkdir \"${sourcedir}\"\n/bin/cp
-Rf \"${SOURCE_ROOT}\"/* \"${sourcedir}\"\n/bin/cp -Rf
\"${BUILT_PRODUCTS_DIR}\"/{skimnotes,SkimNotes.framework,SkimNotesBase.framework,SkimNotes\\
Documentation} \"${basedir}\"\n/bin/cp -f
\"${SOURCE_ROOT}\"/{Licence.txt,SkimNotes.rtf} \"${basedir}\"\n/usr/bin/find
\"${basedir}\" -type f \\( -name \".DS_Store\" -or -name \"*.pbxuser\" -or
-name \"*.mode*\" \\) -delete\n/usr/bin/find \"${basedir}\" -type d -name
\".svn\" -delete\n/usr/bin/tar czf \"${HOME}/Desktop/SkimNotes.tgz\"
\"${basedir}\"\n/bin/rm -rf \"${tmpdir}\"\nexit 0";
};
/* End PBXShellScriptBuildPhase section */
@@ -486,6 +511,16 @@
/* End PBXSourcesBuildPhase section */
/* Begin PBXTargetDependency section */
+ CEA5F5B00E2CF8B100F65088 /* PBXTargetDependency */ = {
+ isa = PBXTargetDependency;
+ target = CEA5F53C0E2CED0E00F65088 /* SkimNotesBase */;
+ targetProxy = CEA5F5AF0E2CF8B100F65088 /*
PBXContainerItemProxy */;
+ };
+ CEA5F6090E2D270500F65088 /* PBXTargetDependency */ = {
+ isa = PBXTargetDependency;
+ target = CE665A840E1C086D00D0704D /* HeaderDocs */;
+ targetProxy = CEA5F6080E2D270500F65088 /*
PBXContainerItemProxy */;
+ };
CEBA2EA60E0673D40000B2E6 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 8DC2EF4F0486A6940098B216 /* SkimNotes */;
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
