Browse Source

More documentation fixes

Pascal Pfiffner 10 years ago
parent
commit
c4f173fcea

+ 1 - 4
Classes/RedlandModel-Convenience.h

@@ -27,10 +27,7 @@
 
 @class RedlandNode, RedlandStatement, RedlandStreamEnumerator, RedlandIteratorEnumerator, RedlandURI;
 
-/** 
- *  @category RedlandModel(Convenience)
- *  @abstract Convenience methods for the RedlandModel class.
- */
+
 @interface RedlandModel (Convenience)
 
 - (RedlandStreamEnumerator *)enumeratorOfStatementsLike:(RedlandStatement *)aStatement;

+ 5 - 5
Classes/RedlandModel.m

@@ -115,7 +115,7 @@
 /**
  *  Returns the number of statements in the receiver.
  *  @return The number of statements in the model, or a negative value on failure.
- *  @attention Not all stores support this function. If you absolutely need an accurate size, you can enumerate the statements manually.
+ *  @warning Not all stores support this function. If you absolutely need an accurate size, you can enumerate the statements manually.
  */
 - (int)size
 {
@@ -127,7 +127,7 @@
 #pragma mark - Statement Handling
 /**
  *  Adds a single statement to the receiver.
-	Duplicate statements are ignored.
+ *  Duplicate statements are ignored.
  *  @param aStatement A complete statement (with non-nil subject, predicate, and object)
  */
 - (void)addStatement:(RedlandStatement *)aStatement
@@ -158,7 +158,7 @@
 
 /**
  *  Adds a stream of statements to the receiver.
-	Duplicate statements are ignored.
+ *  Duplicate statements are ignored.
  *  @param aStream A stream of complete statements
  */
 - (void)addStatementsFromStream:(RedlandStream *)aStream
@@ -209,7 +209,7 @@
 /**
  *  Returns YES if the receiver contains the given statement.
  *  @param aStatement A complete statement
- *  @attention May not work in all cases; use enumeratorOfStatementsLike: instead.
+ *  @warning May not work in all cases; use enumeratorOfStatementsLike: instead.
  */
 - (BOOL)containsStatement:(RedlandStatement *)aStatement
 {
@@ -483,7 +483,7 @@
  *  Sets the model feature identified by featureURI to a new value.
  *  @param featureValue A RedlandNode representing the new value
  *  @param featureURI An NSString or a RedlandURI instance
- *  @attention Raises a RedlandException is no such feature exists.
+ *  @warning Raises a RedlandException is no such feature exists.
  */
 - (void)setValue:(RedlandNode *)featureValue ofFeature:(id)featureURI
 {

+ 12 - 12
Classes/RedlandNamespace.m

@@ -47,7 +47,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
 #pragma mark -
 /**
  *  Initialises the global variables for various predefined namespaces.
- *  @attention There is no need to call this method directly. It is automatically invoked during initialization of the RedlandWorld class.
+ *  @warning There is no need to call this method directly. It is automatically invoked during initialization of the RedlandWorld class.
  */
 + (void)initGlobalNamespaces
 {
@@ -77,7 +77,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
  *  @param aPrefix The URI prefix string which will be prepended to objects created by the new instance, e.g. <tt>http://purl.org/dc/elements/1.1/</tt>
  *  @param aName The short name for this namespace, e.g. <tt>dc</tt>
  *  @return The newly initialised instance
- *  @attention The shortName is currently not used, but may be used later to provide automatic shortening of URIs.
+ *  @warning The shortName is currently not used, but may be used later to provide automatic shortening of URIs.
  */
 - (id)initWithPrefix:(NSString *)aPrefix shortName:(NSString *)aName
 {
@@ -111,9 +111,9 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
 #pragma mark - Registration
 /**
  *  Returns a pre-registered instance with the given short name.
- *  @attention This method allows you to retrieve previously registered namespace instances by their short name. For example, if you call
-	[RDFSyntaxNS registerInstance], you can then get this instance by calling: [RedlandNamespace namespaceWithShortName:\@"rdf"].
- *  @attention Under ARC, this method returns a strong reference.
+ *  @warning This method allows you to retrieve previously registered namespace instances by their short name. For example, if you call
+ *  [RDFSyntaxNS registerInstance], you can then get this instance by calling: [RedlandNamespace namespaceWithShortName:\@"rdf"].
+ *  @warning Under ARC, this method returns a strong reference.
  */
 + (RedlandNamespace *)namespaceWithShortName:(NSString *)aName
 {
@@ -122,7 +122,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
 
 /**
  *  Registers the current instance so it can be retrieved by calling [RedlandNamespace namespaceWithShortName:].
- *  @attention Raises an exception if there is already an instance registered for the receiver's shortName. The receiver automatically unregisters itself when it is deallocated.
+ *  @warning Raises an exception if there is already an instance registered for the receiver's shortName. The receiver automatically unregisters itself when it is deallocated.
  */
 - (void)registerInstance
 {
@@ -134,9 +134,9 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
 
 /**
  *  Removes the registration done by [RedlandNamespace registerInstance].
- *  @attention Does nothing if the receiver is not registered.
- *  @attention Because "+namespaceWithShortName:" returns a strong reference under ARC, we have to query "GlobalNamespaceDict" directly instead since
-	this method is called from within "dealloc".
+ *  @warning Does nothing if the receiver is not registered.
+ *  @warning Because "+namespaceWithShortName:" returns a strong reference under ARC, we have to query "GlobalNamespaceDict" directly instead since
+ *  this method is called from within "dealloc".
  */
 - (void)unregisterInstance
 {
@@ -233,7 +233,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
  *  Returns the local name of the given string in the receiver's namespace.
  *  @param qName A URI string
  *  @return A string generated by stripping the receiver's namespace prefix from the beginning of aString. If the string does not begin with the same prefix as
-	the receiver, nil is returned.
+ *  the receiver, nil is returned.
  */
 - (NSString *)localNameOfURIString:(NSString *)qName
 {
@@ -248,7 +248,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
  *  Returns the local name of the given RedlandNode in the receiver's namespace.
  *  @param aNode A RedlandNode of type resource
  *  @return A string generated by stripping the receiver's namespace prefix from the beginning of aNode's resource URI. If the node's resource URI does not
-	begin with the same prefix as the receiver, or if the node is not of type resource, nil is returned.
+ *  begin with the same prefix as the receiver, or if the node is not of type resource, nil is returned.
  */
 - (NSString *)localNameOfNode:(RedlandNode *)aNode
 {
@@ -260,7 +260,7 @@ static NSMutableDictionary *GlobalNamespaceDict = nil;
  *  Returns the local name of the given RedlandURI in the receiver's namespace.
  *  @param aURI A RedlandURI
  *  @return A string generated by stripping the receiver's namespace prefix from the beginning of aURI. If the URI does not begin with the same prefix as the
-	receiver, nil is returned.
+ *  receiver, nil is returned.
  */
 - (NSString *)localNameOfURI:(RedlandURI *)aURI
 {

+ 7 - 7
Classes/RedlandNode-Convenience.m

@@ -33,7 +33,7 @@
 #pragma mark - Allocators
 /**
  *  Creates and returns a RedlandNode by sending <tt>nodeValue</tt> to the given object.
- *  @attention Raises a RedlandException if the object does not respond to the <tt>nodeValue</tt> selector.
+ *  @warning Raises a RedlandException if the object does not respond to the <tt>nodeValue</tt> selector.
  */
 + (RedlandNode *)nodeWithObject:(id)object
 {
@@ -121,7 +121,7 @@
 #pragma mark - Accessors
 /**
  *  @return the literal integer value of the receiver.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#int</tt>. (Note: This method should probably allow other integer-compatible datatypes as well...)
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#int</tt>. (Note: This method should probably allow other integer-compatible datatypes as well...)
  */
 - (int)intValue
 {
@@ -139,7 +139,7 @@
 
 /**
  *  @return the literal float value of the receiver.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#float</tt>.
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#float</tt>.
  */
 - (float)floatValue
 {
@@ -157,7 +157,7 @@
 
 /**
  *  @return the literal double value of the receiver.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#double</tt>.
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#double</tt>.
  */
 - (double)doubleValue
 {
@@ -180,7 +180,7 @@
 
 /**
  *  @return the literal boolean value of the receiver.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#boolean</tt>.
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#boolean</tt>.
  */
 - (BOOL)boolValue
 {
@@ -200,7 +200,7 @@
 
 /**
  *  If you just want the literal value, no matter what datatype, use <tt>literalValue</tt>.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#string</tt>.
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#string</tt>.
  *  @return the literal string value of the receiver.
  */
 - (NSString *)stringValue
@@ -235,7 +235,7 @@
 
 /**
  *  @return the literal dateTime value of the receiver.
- *  @attention Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#dateTime</tt>.
+ *  @warning Raises a RedlandException if the datatype URI is not <tt>http://www.w3.org/2001/XMLSchema#dateTime</tt>.
  */
 - (NSDate *)dateTimeValue
 {

+ 1 - 1
Classes/RedlandNode.m

@@ -117,7 +117,7 @@
 
 /**
  *  Initializes a new RedlandLiteralNode, with either a language or a datatype URI.
-	
+ *  
  *  @param aString The literal string
  *  @param aLanguage The language of the literal string (ignored if typeURI is present)
  *  @param typeURI The datatype URI (sets aLanguage to nil if present)

+ 3 - 3
Classes/RedlandParser.m

@@ -68,7 +68,7 @@ NSString * const RedlandRelativeURIsFeature = @"http://feature.librdf.org/raptor
 
 /**
  *  Initializes a new RedlandParser of the given type.
- *  @attention See the Redland...ParserName constants for possible values.
+ *  @warning See the Redland...ParserName constants for possible values.
  */
 - (id)initWithName:(NSString *)aName
 {
@@ -214,7 +214,7 @@ NSString * const RedlandRelativeURIsFeature = @"http://feature.librdf.org/raptor
  *  Sets the parser feature identified by featureURI to a new value.
  *  @param featureValue A RedlandNode representing the new value
  *  @param featureURI An NSString or a RedlandURI instance
- *  @attention Raises a RedlandException is no such feature exists.
+ *  @warning Raises a RedlandException is no such feature exists.
  */
 - (void)setValue:(RedlandNode *)featureValue ofFeature:(id)featureURI
 {
@@ -250,7 +250,7 @@ NSString * const RedlandRelativeURIsFeature = @"http://feature.librdf.org/raptor
  *  Fetches data from the given URL using the Cocoa NSURL loading system, parses it with a parser deduced from the returned MIME type, and adds the statements
 	into the given context of the receiver.
 	
- *  @attention This is a nice and uncomplicated convenience function, but it will block until the data has been downloaded and parsed. If the parser type
+ *  @warning This is a nice and uncomplicated convenience function, but it will block until the data has been downloaded and parsed. If the parser type
 	cannot be guessed from the MIME type, an RDF/XML parser will be used.
  */
 - (void)loadURL:(NSURL *)aURL withContext:(RedlandNode *)context

+ 1 - 1
Classes/RedlandQueryResults.h

@@ -41,7 +41,7 @@
 /**
  *  This class represents results from the execution of a RedlandQuery.
  *
- *  @attention Query results work almost like an enumerator. You can go through the results by invoking <tt>next</tt> and get the bindings for each result
+ *  @warning Query results work almost like an enumerator. You can go through the results by invoking <tt>next</tt> and get the bindings for each result
  *  through the various methods defined below. For simplicity, it is recommended that you use the <tt>resultEnumerator</tt> method to get a standard Cocoa
  *  NSEnumerator of the results.
  */

+ 3 - 3
Classes/RedlandQueryResults.m

@@ -130,7 +130,7 @@ RedlandURI * RedlandSPARQLVariableBindingResultsXMLFormat = nil;
 
 /**
  *  @return Returns an RDF graph of the results.
- *  @attention The return value is only meaningful if this is an RDF graph query result.
+ *  @warning The return value is only meaningful if this is an RDF graph query result.
  */
 - (RedlandStream *)resultStream
 {
@@ -166,7 +166,7 @@ RedlandURI * RedlandSPARQLVariableBindingResultsXMLFormat = nil;
 
 /**
  *  @return Returns an enumerator over the query results.
- *  @attention This is the recommended way to evaluate query results.
+ *  @warning This is the recommended way to evaluate query results.
  */
 - (RedlandQueryResultsEnumerator *)resultEnumerator
 {
@@ -216,7 +216,7 @@ RedlandURI * RedlandSPARQLVariableBindingResultsXMLFormat = nil;
 /**
  *  Get boolean query result.
  *  @return Returns > 0 if true, 0 if false, < 0 on error or finished
- *  @attention The return value is only meaningful if this is a boolean query result.
+ *  @warning The return value is only meaningful if this is a boolean query result.
  */
 - (int)getBoolean
 {

+ 2 - 2
Classes/RedlandSerializer.m

@@ -63,7 +63,7 @@ NSString * const RedlandRSS10Serializer = @"rss-1.0";
 
 /**
  *  Initializes a RedlandSerializer with the given name.
- *  @attention See the Redland...SerializerName constants for possible names.
+ *  @warning See the Redland...SerializerName constants for possible names.
  */
 - (id)initWithName:(NSString *)factoryName
 {
@@ -215,7 +215,7 @@ NSString * const RedlandRSS10Serializer = @"rss-1.0";
  *  Sets the serializer feature identified by featureURI to a new value.
  *  @param featureValue A RedlandNode representing the new value
  *  @param featureURI An NSString or a RedlandURI instance
- *  @attention Raises a RedlandException is no such feature exists.
+ *  @warning Raises a RedlandException is no such feature exists.
  */
 - (void)setValue:(RedlandNode *)featureValue ofFeature:(id)featureURI
 {

+ 6 - 6
Classes/RedlandStatement.m

@@ -46,10 +46,10 @@
 
 /**
  *  The designated initializer, initializes a new RedlandStatement.
-	
-	Each parameter can be either be nil, of type RedlandNode, or of any other class that responds to the selector <tt>nodeValue</tt>. The Redland Objective-C
-	framework provides additional <tt>nodeValue</tt> methods for the core Cocoa classes NSString, NSNumber, NSURL, and NSDate.
-	
+ *
+ *  Each parameter can be either be nil, of type RedlandNode, or of any other class that responds to the selector <tt>nodeValue</tt>. The Redland Objective-C
+ *  framework provides additional <tt>nodeValue</tt> methods for the core Cocoa classes NSString, NSNumber, NSURL, and NSDate.
+ *  
  *  @param subjectNode An object representing the subject or source of the statement.
  *  @param predicateNode An object representing the predicate or arc of the statement.
  *  @param objectNode An object representing the object or target of the statement.
@@ -137,7 +137,7 @@
 #pragma mark - Comparing
 /**
  *  @param aStatement The statement to compare the receiver to.
- *  @attention All parts of aStatement which are non-nil must be equal to their counterparts in the receiver.
+ *  @warning All parts of aStatement which are non-nil must be equal to their counterparts in the receiver.
  *  @return Returns YES if the receiver matches aStatement.
  */
 - (BOOL)matchesPartialStatement:(RedlandStatement *)aStatement
@@ -253,7 +253,7 @@
 
 /**
  *  Prints a description of the receiver to standard error.
- *  @attention For debugging purposes.
+ *  @warning For debugging purposes.
  */
 - (void)print
 {

+ 3 - 3
Classes/RedlandWorld.m

@@ -143,7 +143,7 @@ static int redland_log_handler(void *user_data, librdf_log_message *message)
  *  Sets the world feature identified by featureURI to a new value.
  *  @param featureValue A RedlandNode representing the new value
  *  @param featureURI An NSString or a RedlandURI instance
- *  @attention Raises a RedlandException is no such feature exists.
+ *  @warning Raises a RedlandException is no such feature exists.
  */
 - (void)setValue:(RedlandNode *)featureValue ofFeature:(id)featureURI
 {
@@ -178,7 +178,7 @@ static int redland_log_handler(void *user_data, librdf_log_message *message)
  *  Errors are collected until -[RedlandWorld handleStoredErrors] is called, which then throws an exception with all collected errors.
  *  
  *  @param aMessage A librdf_log_message pointer.
- *  @attention Behavior of this method is subject to change. Do not use.
+ *  @warning Behavior of this method is subject to change. Do not use.
  */
 - (int)handleLogMessage:(librdf_log_message *)aMessage
 {
@@ -200,7 +200,7 @@ static int redland_log_handler(void *user_data, librdf_log_message *message)
 
 /**
  *  Checks if there are any collected errors, in which case it throws an exception with the error array inside userInfo dictionary.
- *  @attention Behavior of this method is subject to change. Do not use.
+ *  @warning Behavior of this method is subject to change. Do not use.
  */
 - (void)handleStoredErrors
 {