Fixed code documentation in XMLBasedOutputGenerator and updated log m…

…essages for DocSetOutputGenerator.

DocSetOutputGenerator.m

@@ -357,25 +357,25 @@ - (void) createDocSetBundle
 
 	// First copy the info plist file into the contents output.
 	NSString* plistDestPath = [cmd.outputDocSetContentsPath stringByAppendingPathComponent:@"Info.plist"];
-	logVerbose(@"Copying info plist file to '%@'...", plistDestPath);
+	logVerbose(@"- Copying info plist file to '%@'...", plistDestPath);
 	[Systemator copyItemAtPath:cmd.docsetSourcePlistPath toPath:plistDestPath];
 
 	// Copy all html files to the bundle structure.
-	logVerbose(@"Copying clean XHTML to '%@'...", cmd.outputDocSetDocumentsPath);
+	logVerbose(@"- Copying documentation to '%@'...", cmd.outputDocSetDocumentsPath);
 	[Systemator copyItemAtPath:cmd.outputCleanXHTMLPath toPath:cmd.outputDocSetDocumentsPath];
 
 	// Index the documentation set.
-	logVerbose(@"Indexing DocSet...");
+	logVerbose(@"- Indexing DocSet...");
 	[Systemator runTask:cmd.docsetutilCommandLine, @"index", cmd.outputDocSetPath, nil];
 
 	// Copy the documentation set to the proper directory. First we need to remove
 	// previous files otherwise copying will fail.
 	NSString* docsetInstallPath = [cmd.docsetInstallPath stringByAppendingPathComponent:cmd.docsetBundleID];
-	logVerbose(@"Copying DocSet bundle to '%@'...", docsetInstallPath);
+	logVerbose(@"- Copying DocSet bundle to '%@'...", docsetInstallPath);
 	[Systemator copyItemAtPath:cmd.outputDocSetPath toPath:docsetInstallPath];
 
 	// Install the script to the Xcode.
-	logVerbose(@"Installing DocSet to Xcode...");
+	logVerbose(@"- Installing DocSet to Xcode...");
 	NSMutableString* installCode = [NSMutableString string];
 	[installCode appendString:@"tell application \"Xcode\"\n"];
 	[installCode appendFormat:@"\tload documentation set with path \"%@\"\n", docsetInstallPath];

XMLBasedOutputGenerator+GeneralParsingAPI.h

@@ -11,7 +11,8 @@
 
 //////////////////////////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////////////////////////
-/** Defines general helper methods private for the @c XMLBasedOutputGenerator and it's subclasses.
+/** Defines general helper methods private for the @c XMLBasedOutputGenerator and it's 
+subclasses.
 */
 @interface XMLBasedOutputGenerator (GeneralParsingAPI)
 

XMLBasedOutputGenerator+HierarchyParsingAPI.h

@@ -11,8 +11,8 @@
 
 //////////////////////////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////////////////////////
-/** Defines helper methods private for the @c XMLBasedOutputGenerator and it's subclasses that
-help parsing hierarchy related documentation.
+/** Defines helper methods private for the @c XMLBasedOutputGenerator and it's subclasses 
+that help parsing hierarchy related documentation.
 */
 @interface XMLBasedOutputGenerator (HierarchyParsingAPI)
 

XMLBasedOutputGenerator+HierarchySubclassAPI.h

@@ -22,10 +22,10 @@ hierarchy output generation.
 
 /** Appends any header text before the actual generation starts.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the first message. 
-It gives subclasses a chance to append data to the output before the actual output generation 
-starts. After this message is sent, the rest of the messages are followed and as the last one,
-@c appendHierarchyFooterToData:() is sent.
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the 
+first message. It gives subclasses a chance to append data to the output before the actual 
+output generation starts. After this message is sent, the rest of the messages are followed 
+and as the last one, @c appendHierarchyFooterToData:() is sent.
 
 @param data The data to append to. This is guaranteed to be non @c null.
 @exception NSException Thrown if appending fails.
@@ -36,9 +36,9 @@ starts. After this message is sent, the rest of the messages are followed and as
 
 /** Appends any footer text after output generation ends.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the last message. It 
-gives subclasses a chance to append data to the output after the rest of the output is 
-generated. This is ussually the place to "close" open tags or similar.
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the 
+last message. It gives subclasses a chance to append data to the output after the rest of 
+the output is generated. This is ussually the place to "close" open tags or similar.
 
 @param data The data to append to. This is guaranteed to be non @c null.
 @exception NSException Thrown if appending fails.
@@ -53,10 +53,10 @@ generated. This is ussually the place to "close" open tags or similar.
 
 /** Appends any hierarchy group header text before the actual group items generation starts.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() just before hierarchy 
-group items are generated. It gives subclasses a chance to append data to the output before 
-the generation for group items starts. After this message is sent, at least one 
-@c appendHierarchyGroupItemToData:fromItem:index:() message is sent and then 
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() just 
+before hierarchy group items are generated. It gives subclasses a chance to append data 
+to the output before the generation for group items starts. After this message is sent, 
+at least one @c appendHierarchyGroupItemToData:fromItem:index:() message is sent and then 
 @c appendHierarchyGroupFooterToData:() is sent at the end.
  
 @param data The data to append to. This is guaranteed to be non @c null.
@@ -69,10 +69,10 @@ the generation for group items starts. After this message is sent, at least one
 
 /** Appends any hierarchy group footer text after the group items generation ends.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the last group 
-generation message. It gives subclasses a chance to append data to the output after the 
-generation for hierarchy group ends. This is ussually the place to "close" open tags or 
-similar.
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForHierarchy() as the 
+last group generation message. It gives subclasses a chance to append data to the output 
+after the generation for hierarchy group ends. This is ussually the place to "close" open 
+tags or similar.
  
 Note that this message is sent after all children of all the group items are processed
 so that the subclass can safely assume the whole group is processed well.
@@ -87,9 +87,9 @@ so that the subclass can safely assume the whole group is processed well.
 
 /** Appends the given hierarchy group item data.
 
-This message is sent from @c XMLBasedOutputGenerator::outputDataForHierarchy() for each group member. 
-The subclass should append the data for the given item. The subclass can get more 
-information about the member by using the hierarchy member data methods from the 
+This message is sent from @c XMLBasedOutputGenerator::outputDataForHierarchy() for each 
+group member. The subclass should append the data for the given item. The subclass can 
+get more information about the member by using the hierarchy member data methods from the 
 @c XMLBasedOutputGenerator(HierarchyParsingAPI) category.
  
 @param data The data to append to. This is guaranteed to be non @c null.

XMLBasedOutputGenerator+IndexParsingAPI.h

@@ -11,8 +11,8 @@
 
 //////////////////////////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////////////////////////
-/** Defines helper methods private for the @c XMLBasedOutputGenerator and it's subclasses that
-help parsing index related documentation.
+/** Defines helper methods private for the @c XMLBasedOutputGenerator and it's subclasses 
+that help parsing index related documentation.
 */
 @interface XMLBasedOutputGenerator (IndexParsingAPI)
 

XMLBasedOutputGenerator+IndexSubclassAPI.h

@@ -22,10 +22,10 @@ index output generation.
 
 /** Appends any header text before the actual generation starts.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the first message. 
-It gives subclasses a chance to append data to the output before the actual output generation 
-starts. After this message is sent, the rest of the messages are followed and as the last one,
-@c appendIndexFooterToData:() is sent.
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the first
+message. It gives subclasses a chance to append data to the output before the actual output 
+generation starts. After this message is sent, the rest of the messages are followed and as 
+the last one, @c appendIndexFooterToData:() is sent.
 
 @param data The data to append to. This is guaranteed to be non @c null.
 @exception NSException Thrown if appending fails.
@@ -36,9 +36,9 @@ starts. After this message is sent, the rest of the messages are followed and as
 
 /** Appends any footer text after output generation ends.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the last message. It 
-gives subclasses a chance to append data to the output after the rest of the output is 
-generated. This is ussually the place to "close" open tags or similar.
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the last 
+message. It gives subclasses a chance to append data to the output after the rest of the 
+output is generated. This is ussually the place to "close" open tags or similar.
 
 @param data The data to append to. This is guaranteed to be non @c null.
 @exception NSException Thrown if appending fails.
@@ -53,9 +53,9 @@ generated. This is ussually the place to "close" open tags or similar.
 
 /** Appends any index group header text before the actual group items generation starts.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() just before index group 
-items are generated. It gives subclasses a chance to append data to the output before the 
-generation for group items starts. After this message is sent, at least one 
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() just before 
+index group items are generated. It gives subclasses a chance to append data to the output 
+before the generation for group items starts. After this message is sent, at least one 
 @c appendIndexGroupItemToData:fromItem:index:type:() message is sent and then 
 @c appendIndexGroupFooterToData:type:() is sent at the end.
  
@@ -76,8 +76,8 @@ The type identifies the type of the index group and can be one of the following:
 
 /** Appends any index group footer text after the group items generation ends.
 
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the last group 
-generation message. It gives subclasses a chance to append data to the output after the 
+The message is sent from the @c XMLBasedOutputGenerator::outputDataForIndex() as the last 
+group generation message. It gives subclasses a chance to append data to the output after the 
 generation for index group ends. This is ussually the place to "close" open tags or similar.
 
 The type identifies the type of the index group and can be one of the following:
@@ -97,8 +97,8 @@ The type identifies the type of the index group and can be one of the following:
 
 /** Appends the given index group item data.
 
-This message is sent from @c XMLBasedOutputGenerator::outputDataForIndex() for each group member. 
-The subclass should append the data for the given item. The subclass can get more 
+This message is sent from @c XMLBasedOutputGenerator::outputDataForIndex() for each group 
+member. The subclass should append the data for the given item. The subclass can get more 
 information about the member by using the index member data methods from the 
 @c XMLBasedOutputGenerator(IndexParsingAPI) category.