Skip to content

Commit

Permalink
Fixed overview section generation.
Browse files Browse the repository at this point in the history
The regression was introduced with one of recent contributions. My guess is the contributor was using older code base and didn't update before issuing pull request. The same issue repeated second time, to prevent further regressions, I added a comment to source code specifically guarding against changing affected lines. Not the best approach, but at least something until 3.0 is out...
  • Loading branch information
tomaz committed Dec 14, 2012
1 parent dac79b8 commit 8f41538
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion AppledocTests-Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>840</string>
<string>858</string>
</dict>
</plist>
2 changes: 1 addition & 1 deletion Application/GBApplicationStringsProvider.m
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ - (NSDictionary *)appledocData {
result = [[NSMutableDictionary alloc] init];
[result setObject:@"appledoc" forKey:@"tool"];
[result setObject:@"2.1" forKey:@"version"];
[result setObject:@"840" forKey:@"build"];
[result setObject:@"858" forKey:@"build"];
[result setObject:@"http://appledoc.gentlebytes.com" forKey:@"homepage"];
}
return result;
Expand Down
6 changes: 3 additions & 3 deletions Processing/GBCommentsProcessor.m
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,9 @@ - (void)processCommentBlockInLines:(NSArray *)lines blockRange:(NSRange)blockRan
if ([blockString length] == 0) return;

// Process the string and register long description component.
//GBCommentComponent *component = [self commentComponentByPreprocessingString:blockString withFlags:0];

//[self.currentComment.longDescription registerComponent:component];
// **IMPORTANT CONTRIBUTORS NOTE:** do NOT comment or change following two lines. Doing so will brake overview section being created for classes, categories and protocols! Most often this happens with folks wanting to bring in better HeaderDoc support, but it brakes "standard" appledoc way of dealing comments. While I symphatize with ideas of supporting as wide audience as possible, native appledoc users are still larger audience than HeaderDoc, so please find another way. My suggestion would be via cmd line switch that would change behavior from appledoc to HeaderDoc, then opt out with an if statement.
GBCommentComponent *component = [self commentComponentByPreprocessingString:blockString withFlags:0];
[self.currentComment.longDescription registerComponent:component];
}

- (void)registerShortDescriptionFromLines:(NSArray *)lines range:(NSRange)range removePrefix:(NSString *)remove {
Expand Down

0 comments on commit 8f41538

Please sign in to comment.