Revision: 13840
http://sourceforge.net/p/skim-app/code/13840
Author: hofman
Date: 2023-12-06 10:14:59 +0000 (Wed, 06 Dec 2023)
Log Message:
-----------
use nil instead of NULL in documentation
Modified Paths:
--------------
trunk/SkimNotes/NSFileManager_SKNExtensions.h
trunk/SkimNotes/PDFAnnotation_SKNExtensions.h
Modified: trunk/SkimNotes/NSFileManager_SKNExtensions.h
===================================================================
--- trunk/SkimNotes/NSFileManager_SKNExtensions.h 2023-12-05 22:33:34 UTC
(rev 13839)
+++ trunk/SkimNotes/NSFileManager_SKNExtensions.h 2023-12-06 10:14:59 UTC
(rev 13840)
@@ -69,7 +69,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or <code>NULL</code> if there was an error
reading the Skim notes.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or <code>nil</code> if there was an error
reading the Skim notes.
*/
- (nullable NSArray<NSDictionary<NSString *, id> *>
*)readSkimNotesFromExtendedAttributesAtURL:(NSURL *)aURL error:(NSError
**)outError;
@@ -78,7 +78,7 @@
@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.
@param outError If there is an error reading the text Skim notes,
upon return contains an <code>NSError</code> object that describes the problem.
- @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or <code>NULL</code> if there was an error
reading the text Skim notes.
+ @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or <code>nil</code> if there was an error
reading the text Skim notes.
*/
- (nullable NSString *)readSkimTextNotesFromExtendedAttributesAtURL:(NSURL
*)aURL error:(NSError **)outError;
@@ -87,7 +87,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result <code>NSData</code> for an RTF representation of the Skim
notes, an empty <code>NSData</code> object if no RTF Skim notes were found, or
<code>NULL</code> if there was an error reading the RTF Skim notes.
+ @result <code>NSData</code> for an RTF representation of the Skim
notes, an empty <code>NSData</code> object if no RTF Skim notes were found, or
<code>nil</code> if there was an error reading the RTF Skim notes.
*/
- (nullable NSData *)readSkimRTFNotesFromExtendedAttributesAtURL:(NSURL *)aURL
error:(NSError **)outError;
@@ -96,7 +96,7 @@
@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 <code>NULL</code> if there was an error
reading the Skim notes.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or <code>nil</code> if there was an error
reading the Skim notes.
*/
- (nullable NSArray<NSDictionary<NSString *, id> *>
*)readSkimNotesFromPDFBundleAtURL:(NSURL *)aURL error:(NSError **)outError;
@@ -105,7 +105,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or <code>NULL</code> if there was an error
reading the text Skim notes.
+ @result A string representation of the Skim notes, an empty string if
no text Skim notes were found, or <code>nil</code> if there was an error
reading the text Skim notes.
*/
- (nullable NSString *)readSkimTextNotesFromPDFBundleAtURL:(NSURL *)aURL
error:(NSError **)outError;
@@ -114,7 +114,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result <code>NSData</code> for an RTF representation of the Skim
notes, an empty <code>NSData</code> object if no RTF Skim notes were found, or
<code>NULL</code> if there was an error reading the RTF Skim notes.
+ @result <code>NSData</code> for an RTF representation of the Skim
notes, an empty <code>NSData</code> object if no RTF Skim notes were found, or
<code>nil</code> if there was an error reading the RTF Skim notes.
*/
- (nullable NSData *)readSkimRTFNotesFromPDFBundleAtURL:(NSURL *)aURL
error:(NSError **)outError;
@@ -123,7 +123,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or <code>NULL</code> if there was an error
reading the Skim notes.
+ @result An array of dictionaries with Skim note properties, an empty
array if no Skim notes were found, or <code>nil</code> if there was an error
reading the Skim notes.
*/
- (nullable NSArray<NSDictionary<NSString *, id> *>
*)readSkimNotesFromSkimFileAtURL:(NSURL *)aURL error:(NSError **)outError;
@@ -141,8 +141,8 @@
@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 Calls
<code>writeSkimNotes:textNotes:richTextNotes:toExtendedAttributesAtURL:options:error:</code>
with the <code>SKNSkimNotesWritingPlist<code> and
<code>SKNSkimNotesWritingSyncable<code> options.
@param notes An array of dictionaries containing Skim note
properties, as returned by the properties of a <code>PDFAnnotation</code>.
- @param notesString A text representation of the Skim notes. When
<code>NULL</code>, a default representation will be generated from notes.
- @param notesRTFData An RTF data representation of the Skim notes.
When <code>NULL</code>, a default representation will be generated from notes.
+ @param notesString A text representation of the Skim notes. When
<code>nil</code>, a default representation will be generated from notes.
+ @param notesRTFData An RTF data representation of the Skim notes.
When <code>nil</code>, 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 <code>NSError</code> object that describes the problem.
@result Returns <code>YES</code> if writing out the Skim notes was
successful; otherwise returns <code>NO</code>.
@@ -153,8 +153,8 @@
@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> or as plist data, depending on the options.
@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>.
- @param notesString A text representation of the Skim notes. When
<code>NULL</code>, a default representation will be generated from notes.
- @param notesRTFData An RTF data representation of the Skim notes. When
<code>NULL</code>, a default representation will be generated from notes.
+ @param notesString A text representation of the Skim notes. When
<code>nil</code>, a default representation will be generated from notes.
+ @param notesRTFData An RTF data representation of the Skim notes. When
<code>nil</code>, a default representation will be generated from notes.
@param aURL The URL for the file to write the Skim notes to.
@param options The write options to use.
@param outError If there is an error writing the Skim notes, upon return
contains an <code>NSError</code> object that describes the problem.
@@ -189,7 +189,7 @@
@param extension The file extension for which to find a bundled file.
@param aURL The URL to the PDF bundle.
@param outError If there is an error getting the bundled file, upon
return contains an <code>NSError</code> object that describes the problem.
- @result A file URL to the bundled file inside the PDF bundle, or
<code>NULL</code> if no bundled file was found.
+ @result A file URL to the bundled file inside the PDF bundle, or
<code>nil</code> if no bundled file was found.
*/
- (NSURL *)bundledFileURLWithExtension:(NSString *)extension
inPDFBundleAtURL:(NSURL *)aURL error:(NSError **)outError;
@@ -199,7 +199,7 @@
@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 <code>NSError</code> object that describes the problem.
- @result A full path to the bundled file inside the PDF bundle, or
<code>NULL</code> if no bundled file was found.
+ @result A full path to the bundled file inside the PDF bundle, or
<code>nil</code> 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 2023-12-05 22:33:34 UTC
(rev 13839)
+++ trunk/SkimNotes/PDFAnnotation_SKNExtensions.h 2023-12-06 10:14:59 UTC
(rev 13840)
@@ -265,7 +265,7 @@
@abstract Initializes a new Skim note annotation. This is the
designated initializer for a Skim note on macOS.
@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
<code>NULL</code> if the object could not be initialized.
+ @result An initialized Skim note annotation instance, or
<code>nil</code> if the object could not be initialized.
*/
- (nullable id)initSkimNoteWithBounds:(NSRect)bounds;
#endif
@@ -275,7 +275,7 @@
@discussion On macOS this returns a subclasses initialized with
<code>initSkimNoteWithBounds:</code>.
@param bounds The bounding box of the annotation, in page space.
@param type The type of the note .
- @result An initialized Skim note annotation instance, or
<code>NULL</code> if the object could not be initialized.
+ @result An initialized Skim note annotation instance, or
<code>nil</code> if the object could not be initialized.
*/
- (nullable id)initSkimNoteWithBounds:(PDFRect)bounds forType:(NSString *)type;
@@ -283,7 +283,7 @@
@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>.
- @result An initialized Skim note annotation instance, or
<code>NULL</code> if the object could not be initialized.
+ @result An initialized Skim note annotation instance, or
<code>nil</code> if the object could not be initialized.
*/
- (nullable id)initSkimNoteWithProperties:(NSDictionary<NSString *, id> *)dict;
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
Skim-app-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/skim-app-commit
