Merge pull request #195 from jerryhjones/master

Description-less @param fix, headerdoc preprocessing update & tokens template fox. Thanks to @JerryJones. Closes #195.
tomaz · Mar 2, 2012 · 5a7b3d8 · 5a7b3d8
2 parents d0b2c17 + aea9a05
commit 5a7b3d8
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 9 deletions.
diff --git a/Parsing/GBTokenizer.m b/Parsing/GBTokenizer.m
@@ -302,10 +302,14 @@ - (NSString *)lineByPreprocessingHeaderDocDirectives:(NSString *)line {
 
 	// Remove the entire line when it contains @method or property or class.
 	line = [line stringByReplacingOccurrencesOfRegex:@"(?m:@(protocol|method|property|class).*$)" withString:@""];
-
+	
 	// Remove unsupported headerDoc words.
 	line = [line stringByReplacingOccurrencesOfRegex:@"(?m:^\\s*@(discussion|abstract))\\s?" withString:@"\n"];    
-
+
+	// Remove unsupported Doxygen words.
+	line = [line stringByReplacingOccurrencesOfRegex:@"(?m:^\\s*@(brief))\\s?" withString:@""];    
+	line = [line stringByReplacingOccurrencesOfRegex:@"(?m:^\\s*@(details))\\s?" withString:@"\n"];
+
 	// Replace methodgroup with name.
 	line = [line stringByReplacingOccurrencesOfRegex:@"(?:@(methodgroup|group))" withString:@"@name"];  
 	return line;

diff --git a/Processing/GBCommentsProcessor.m b/Processing/GBCommentsProcessor.m
@@ -314,10 +314,17 @@ - (BOOL)processParamBlockInString:(NSString *)string lines:(NSArray *)lines bloc
 	// Get data from captures. Index 1 is directive, index 2 name, index 3 description text.
 	NSString *name = [components objectAtIndex:2];
 	NSString *description = [components objectAtIndex:3];
-	NSString *prefix = [string substringToIndex:[string rangeOfString:description].location];
+	NSRange range = [string rangeOfString:description];
+	NSString *prefix = nil;
+	if (range.location < [string length]) {
+		prefix = [string substringToIndex:range.location];
+	} else {
+		prefix = @"";
+	}
+
 	GBLogDebug(@"- Registering parameter %@ description %@ at %@...", name, [description normalizedDescription], self.currentSourceInfo);
 	[self reserveShortDescriptionFromLines:lines range:shortRange removePrefix:prefix];
-
+	
 	// Prepare object representation from the description and register the parameter to the comment.
 	GBCommentArgument *argument = [GBCommentArgument argumentWithName:name sourceInfo:self.currentSourceInfo];
 	GBCommentComponent *component = [self commentComponentByPreprocessingString:description withFlags:0];
@@ -333,7 +340,14 @@ - (BOOL)processExceptionBlockInString:(NSString *)string lines:(NSArray *)lines
 	// Get data from captures. Index 1 is directive, index 2 name, index 3 description text.
 	NSString *name = [components objectAtIndex:2];
 	NSString *description = [components objectAtIndex:3];
-	NSString *prefix = [string substringToIndex:[string rangeOfString:description].location];
+	NSRange range = [string rangeOfString:description];
+	NSString *prefix = nil;
+	if (range.location < [string length]) {
+		prefix = [string substringToIndex:range.location];
+	} else {
+		prefix = @"";
+	}
+
 	GBLogDebug(@"- Registering exception %@ description %@ at %@...", name, [description normalizedDescription], self.currentSourceInfo);
 	[self reserveShortDescriptionFromLines:lines range:shortRange removePrefix:prefix];
 
@@ -351,7 +365,14 @@ - (BOOL)processAvailabilityBlockInString:(NSString *)string lines:(NSArray *)lin
 
 	// Get data from captures. Index 1 is directive, index 2 description text.
 	NSString *description = [components objectAtIndex:2];
-	NSString *prefix = [string substringToIndex:[string rangeOfString:description].location];
+	NSRange range = [string rangeOfString:description];
+	NSString *prefix = nil;
+	if (range.location < [string length]) {
+		prefix = [string substringToIndex:range.location];
+	} else {
+		prefix = @"";
+	}
+
 	GBLogDebug(@"- Registering availability description %@ at %@...", [description normalizedDescription], self.currentSourceInfo);
 	[self reserveShortDescriptionFromLines:lines range:shortRange removePrefix:prefix];
 
@@ -367,7 +388,14 @@ - (BOOL)processReturnBlockInString:(NSString *)string lines:(NSArray *)lines blo
 
 	// Get data from captures. Index 1 is directive, index 2 description text.
 	NSString *description = [components objectAtIndex:2];
-	NSString *prefix = [string substringToIndex:[string rangeOfString:description].location];
+	NSRange range = [string rangeOfString:description];
+	NSString *prefix = nil;
+	if (range.location < [string length]) {
+		prefix = [string substringToIndex:range.location];
+	} else {
+		prefix = @"";
+	}
+
 	GBLogDebug(@"- Registering return description %@ at %@...", [description normalizedDescription], self.currentSourceInfo);
 	[self reserveShortDescriptionFromLines:lines range:shortRange removePrefix:prefix];
 
@@ -383,7 +411,14 @@ - (BOOL)processRelatedBlockInString:(NSString *)string lines:(NSArray *)lines bl
 
 	// Get data from captures. Index 1 is directive, index 2 reference.
 	NSString *reference = [components objectAtIndex:2];
-	NSString *prefix = [string substringToIndex:[string rangeOfString:reference].location];
+	NSRange range = [string rangeOfString:reference];
+	NSString *prefix = nil;
+	if (range.location < [string length]) {
+		prefix = [string substringToIndex:range.location];
+	} else {
+		prefix = @"";
+	}
+
 	GBLogDebug(@"- Registering related symbol %@ at %@...", reference, self.currentSourceInfo);
 	[self reserveShortDescriptionFromLines:lines range:shortRange removePrefix:prefix];
 

diff --git a/Templates/docset/Contents/Resources/tokens-template.xml b/Templates/docset/Contents/Resources/tokens-template.xml
@@ -56,6 +56,6 @@ Section MethodDeclaration
 EndSection
 
 Section GBCommentComponentsList
-{{#components}}{{&textValue}}{{/components}}
+{{#components}}{{textValue}}{{/components}}
 EndSection