Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed code documentation in XMLBasedOutputGenerator and updated log m…

…essages for DocSetOutputGenerator.
  • Loading branch information...
commit 04e71891d1aeac0eff14a12902405e81e3ebc769 1 parent 1661cb8
@tomaz authored
View
10 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];
View
3  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)
View
4 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)
View
36 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.
View
4 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)
View
28 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.
View
149 XMLBasedOutputGenerator+ObjectSubclassAPI.h
@@ -22,27 +22,27 @@ objects output generation.
/** Appends any header text before the actual generation starts.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() 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 appendObjectFooterToData:() is sent.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() 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 appendObjectFooterToData:() is sent.
@param data The data to append to. This is guaranteed to be non @c null.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectFooterToData:
*/
- (void) appendObjectHeaderToData:(NSMutableData*) data;
/** Appends any footer text after output generation ends.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() 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::generateOutputForObject:() 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.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectHeaderToData:
*/
- (void) appendObjectFooterToData:(NSMutableData*) data;
@@ -53,15 +53,15 @@ generated. This is ussually the place to "close" open tags or similar.
/** Appends any object info header text before the actual generation starts.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() just before object info
-items are generated. It gives subclasses a chance to append data to the output before the
-generation for secion items starts. After this message is sent, at least one
-@c appendObjectInfoItemToData:fromItems:index:type:() message is sent and then
-@c appendObjectInfoHeaderToData:() is sent at the end.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() just
+before object info items are generated. It gives subclasses a chance to append data to
+the output before the generation for secion items starts. After this message is sent,
+at least one @c appendObjectInfoItemToData:fromItems:index:type:() message is sent and
+then @c appendObjectInfoHeaderToData:() is sent at the end.
@param data The data to append to. This is guaranteed to be non @c null.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectInfoItemToData:fromItems:index:type:
@see appendObjectInfoFooterToData:
*/
@@ -69,13 +69,14 @@ generation for secion items starts. After this message is sent, at least one
/** Appends any object info footer text after the object info items generation ends.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() as the last info
-generation message. It gives subclasses a chance to append data to the output after the
-info items generation is finished. This is ussually the place to "close" open tags or similar.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() as the
+last info generation message. It gives subclasses a chance to append data to the output
+after the info items generation is finished. 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.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectInfoHeaderToData:
@see appendObjectInfoItemToData:fromItems:index:type:
*/
@@ -83,10 +84,11 @@ info items generation is finished. This is ussually the place to "close" open ta
/** Appends the given object info item data.
-This message is sent from @c XMLBasedOutputGenerator::outputDataForObject() for each applicable object
-info item type. The subclass should append the data for the given item. The subclass can get
-more information about the object info item by investigating the given array which
-contains objects that can be used to query additional data for individual item.
+This message is sent from @c XMLBasedOutputGenerator::generateOutputForObject:() for each
+applicable object info item type. The subclass should append the data for the given item.
+The subclass can get more information about the object info item by investigating the
+given array which contains objects that can be used to query additional data for
+individual item.
The type identifies the type of the info item and can be one of the following:
- @c kTKInfoItemInherits: The @c nodes contain inherit from information. Only one node
@@ -101,7 +103,7 @@ The type identifies the type of the info item and can be one of the following:
@param index Zero based index of the item within the info object info.
@param type The type of the item.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectInfoHeaderToData:
@see appendObjectInfoFooterToData:
*/
@@ -116,15 +118,15 @@ The type identifies the type of the info item and can be one of the following:
/** Appends object overview description.
-This message is sent from @c XMLBasedOutputGenerator::outputDataForObject() if the object has brief
-and or detailed documentation assigned. It gives subclasses a chance to append object overview
-from the gathered documentation. The given @c item contains brief and detailed object
-description and can be treated as any other description item.
+This message is sent from @c XMLBasedOutputGenerator::generateOutputForObject:() if the object
+has brief and or detailed documentation assigned. It gives subclasses a chance to append
+object overview from the gathered documentation. The given @c item contains brief and
+detailed object description and can be treated as any other description item.
@param data The data to append to. This is guaranteed to be non @c null.
@param item The item that contains the brief and detailed description.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
*/
- (void) appendObjectOverviewToData:(NSMutableData*) data
fromItem:(id) item;
@@ -135,14 +137,15 @@ description and can be treated as any other description item.
/** Appends any tasks header before the actual tasks generation starts.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() if the object has at
-least one task defined. It gives subclasses a chance to append data to the output before
-any individual task handling is started. After this message is sent, each individual
-task is handled and when all tasks are done, @c appendObjectTasksFooterToData:() is sent.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() if the
+object has at least one task defined. It gives subclasses a chance to append data to the
+output before any individual task handling is started. After this message is sent, each
+individual task is handled and when all tasks are done, @c appendObjectTasksFooterToData:()
+is sent.
@param data The data to append to. This is guaranteed to be non @c null.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectTaskHeaderToData:fromItem:index:
@see appendObjectTaskFooterToData:fromItem:index:
@see appendObjectTasksFooterToData:
@@ -151,13 +154,13 @@ task is handled and when all tasks are done, @c appendObjectTasksFooterToData:()
/** Appends any tasks footer after sections generation ends.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() after all tasks have
-been processed. It gives subclasses a chance to append data to the output at that point.
-This is ussually the place to "close" tasks open tags or similar.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() after all
+tasks have been processed. It gives subclasses a chance to append data to the output at
+that point. This is ussually the place to "close" tasks 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.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectTasksHeaderToData:
@see appendObjectTaskHeaderToData:fromItem:index:
@see appendObjectTaskMemberToData:fromItem:index:
@@ -167,15 +170,15 @@ This is ussually the place to "close" tasks open tags or similar.
/** Appends an individual task header before the task members generation starts.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() for each task which
-has at least one member. It gives subclasses a chance to append data to the output before
-member handling for the given task starts.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() for each
+task which has at least one member. It gives subclasses a chance to append data to the
+output before member handling for the given task starts.
@param data The data to append to. This is guaranteed to be non @c null.
@param item The item that contains the task description.
@param index Zero based index of the task.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectTasksHeaderToData:
@see appendObjectTaskMemberToData:fromItem:index:
@see appendObjectTaskFooterToData:fromItem:index:
@@ -187,15 +190,15 @@ member handling for the given task starts.
/** Appends an individual task footer after the task members generation ends.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() after all task members
-have been processed. It gives subclasses a chance to append data to the output at that
-point. This is ussually the place to "close" tasks open tags or similar.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() after all
+task members have been processed. It gives subclasses a chance to append data to the output
+at that point. This is ussually the place to "close" tasks open tags or similar.
@param data The data to append to. This is guaranteed to be non @c null.
@param item The item that contains the task description.
@param index Zero based index of the task.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectTasksHeaderToData:
@see appendObjectTaskHeaderToData:fromItem:index:
@see appendObjectTaskMemberToData:fromItem:index:
@@ -207,15 +210,15 @@ point. This is ussually the place to "close" tasks open tags or similar.
/** Appends a task member data.
-This message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() for each task member
-(class or instance method or property. Subclasses should append any desired data for the
-given member.
+This message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() for each
+task member (class or instance method or property). Subclasses should append any desired
+data for the given member.
@param data The data to append to. This is guaranteed to be non @c null.
@param item The item that contains the task member description.
@param index Zero based index of the member within the task.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectTasksHeaderToData:
@see appendObjectTaskHeaderToData:fromItem:index:
@see appendObjectTaskFooterToData:fromItem:index:
@@ -231,15 +234,15 @@ given member.
/** Appends any main members documentation header before the actual member generation starts.
-The message is sent from the @c XMLBasedOutputGenerator::outputDataForObject() if the object has at least
-one main member group defined. It gives subclasses a chance to append data to the output
-before any individual member handling is started. After this message is sent, each individual
-member group is handled and when all members are done, @c appendObjectMembersFooterToData:() is
-sent.
+The message is sent from the @c XMLBasedOutputGenerator::generateOutputForObject:() if the
+object has at least one main member group defined. It gives subclasses a chance to append
+data to the output before any individual member handling is started. After this message
+is sent, each individual member group is handled and when all members are done,
+@c appendObjectMembersFooterToData:() is sent.
@param data The data to append to. This is guaranteed to be non @c null.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectMembersFooterToData:
@see appendObjectMemberGroupHeaderToData:type:
@see appendObjectMemberGroupFooterToData:type:
@@ -249,13 +252,13 @@ sent.
/** Appends any main members documentation footer after members generation ends.
-The message is sent from the @cXMLBasedOutputGenerator:: outputDataForObject() after all member groups
-have been processed. It gives subclasses a chance to append data to the output at that point.
-This is ussually the place to "close" sections open tags or similar.
+The message is sent from the @cXMLBasedOutputGenerator:: generateOutputForObject:() after all
+member groups have been processed. It gives subclasses a chance to append data to the
+output at that point. This is ussually the place to "close" sections 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.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectMembersHeaderToData:
@see appendObjectMemberGroupHeaderToData:type:
@see appendObjectMemberGroupFooterToData:type:
@@ -265,23 +268,23 @@ This is ussually the place to "close" sections open tags or similar.
/** Appends member group header data.
-This message is sent from @c XMLBasedOutputGenerator::outputDataForObject() for each main member
-documentation group. The group is specified with the @c type parameter and can be one of
-the following:
+This message is sent from @c XMLBasedOutputGenerator::generateOutputForObject:() for each
+main member documentation group. The group is specified with the @c type parameter and
+can be one of the following:
- @c kTKObjectMemberTypeClass: The group describes class members.
- @c kTKObjectMemberTypeInstance: The group describes instance members.
- @c kTKObjectMemberTypeProperty: The group describes properties.
Subclasses should append any desired data for the given group type. The message is only
sent if at least one member of the given type is documented for the object. After this
-message one or more @c appendObjectMemberToData:fromItem:index:() messages are sent, one for
-each documented member of the given group and after all members output is generated,
+message one or more @c appendObjectMemberToData:fromItem:index:() messages are sent, one
+for each documented member of the given group and after all members output is generated,
@c appendObjectMemberGroupHeaderToData:type:() is sent.
@param data The data to append to. This is guaranteed to be non @c null.
@param type The type of the group that is being described.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectMembersHeaderToData:
@see appendObjectMembersFooterToData:
@see appendObjectMemberToData:fromItem:index:
@@ -292,9 +295,9 @@ each documented member of the given group and after all members output is genera
/** Appends member group footer data.
-This message is sent from @c XMLBasedOutputGenerator::outputDataForObject() for each main member
-documentation group. The group is specified by the @c type parameter and can be one of
-the following:
+This message is sent from @c XMLBasedOutputGenerator::generateOutputForObject:() for each main
+member documentation group. The group is specified by the @c type parameter and can be
+one of the following:
- @c kTKObjectMemberTypeClass: The group describes class members.
- @c kTKObjectMemberTypeInstance: The group describes instance members.
- @c kTKObjectMemberTypeProperty: The group describes properties.
@@ -306,7 +309,7 @@ corresponding @c appendObjectMemberGroupHeaderToData:type:() was sent.
@param data The data to append to. This is guaranteed to be non @c null.
@param type The type of the group that is being described.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectMembersHeaderToData:
@see appendObjectMembersFooterToData:
@see appendObjectMemberGroupHeaderToData:type:
@@ -317,14 +320,14 @@ corresponding @c appendObjectMemberGroupHeaderToData:type:() was sent.
/** Appends individual member full documentation data.
-This message is sent from @c XMLBasedOutputGenerator::outputDataForObject() for each documented member.
-Subclasses should output the full documentation for the given member.
+This message is sent from @c XMLBasedOutputGenerator::generateOutputForObject:() for each
+documented member. Subclasses should output the full documentation for the given member.
@param data The data to append to. This is guaranteed to be non @c null.
@param item The item that describes the member data.
@param index Zero based index of the member within the group.
@exception NSException Thrown if appending fails.
-@see XMLBasedOutputGenerator::outputDataForObject
+@see XMLBasedOutputGenerator::generateOutputForObject:
@see appendObjectMembersHeaderToData:
@see appendObjectMembersFooterToData:
@see appendObjectMemberGroupHeaderToData:type:
View
5 XMLBasedOutputGenerator.h
@@ -65,7 +65,7 @@ should be very small ammount of work for subclasses.
Each concrete subclass can convert three types of files - index, hierarchy and object files.
The subclass can only override the methods for generating output that makes sense for the
implemented output type. The @c XMLBasedOutputGenerator overrides the
-@c genearteSpecificOutput() in which it delegates the concrete output generation through
+@c generateSpecificOutput() in which it delegates the concrete output generation through
the following messages:
- @c generateOutputForIndex() to generate the main index file,
- @c generateOutputForHierarchy() to generate the main hierarchy file and
@@ -217,7 +217,8 @@ Note that this always return formatted current system time.
/** Returns the status of output files generation.
This returns @c YES if at least one output file was generated within the last generation
-run (i.e. between the @c generationStarting() and @c generationFinished() messages).
+run (i.e. between the @c outputGenerationStarting() and @c outputGenerationFinished()
+messages).
*/
@property(readonly) BOOL outputFileWasCreated;
Please sign in to comment.
Something went wrong with that request. Please try again.