-
I tried removing the /\S/, but it causes the last line of the prototype to be a an almost blank line with the '}' or '} typename' at the end of it. Is that what you intended? I think I prefer the ending brace to be on the same line as the last parameter.
2009-12-14 17:28:04 UTC by jasp1
-
Ah, I didn't think of that. Yes, it makes sense to strip the comments earlier in the process so symbols in the comments don't affect how the parameters are divided. You shouldn't need the second part with /\S/ anymore.
2009-12-14 04:08:11 UTC by gregvalure
-
Greg,
Turns out your suggested patch gets tripped up by special characters inside the comment, like ":" or "=". I was able to improve the behavior by performing the following modification:
--- NaturalDocs-1.4.orig/Modules/NaturalDocs/Languages/Base.pm 2008-09-17 09:46:17.000000000 -0600
+++ NaturalDocs-1.4/Modules/NaturalDocs/Languages/Base.pm 2009-12-12 23:14:47.105930000...
2009-12-13 06:20:19 UTC by jasp1
-
At the moment it is only possible to generate documentation from a directory. It would be nice to be able to specify files as input, explicitly.
Something like:
NaturalDocs -i foo.h bar.h -o HTML doc -p nd.
2009-12-11 14:15:00 UTC by nobody
-
See responses to this query in the Development forum, where the question was originally (incorrectly) posted.
-Jay.
2009-12-09 17:39:19 UTC by jasp1
-
Greg: Thanks, your suggestion worked great.
XL64: Thanks for the info, but that's not exactly what I was looking for. Folks already have structured description comments. The key was to capture the exact prototype at the top of the description.
-Jay.
2009-12-09 05:57:22 UTC by jasp1
-
merci pour votre réponse,
j espérai qu'il y ait un caractère non pris en compte dans la documentation afin d'éviter de saisir deux zones de commentaire, mais apparemment ceci est inévitable.
2009-12-04 10:39:38 UTC by nobody
-
If you are interested in something to transform
/* Type: example_t
*
* This is a the description of the type
*
*/
typdef struct {
int field1; /*+ number of items +*/
double field2; /*+ seconds +*/
} example_t;
Into something like that :
/* Type: example_t
*
* This is a the description of the type
*.
2009-12-03 13:04:27 UTC by xl64
-
[ND Dir]/Modules/NaturalDocs/Languages/Base.pm. Search for "sub ParsePrototype" and this is at the very end:
foreach my $parameterLine (@parameterLines)
{
$prototypeObject->AddParameter( $self->ParseParameterLine($parameterLine) );
};
These are the raw parameter lines before they get parsed further. However, the items are split by commas and semicolons...
2009-12-02 18:21:05 UTC by gregvalure
-
Greg,
Any chance there's a simple hack to strip ALL comments from the prototypes? That would solve our de-splintify problem too.
Ironically, it may have been me that first asked you about splint comments showing up in the prototypes. For some reason I can't remember now we decided it was better to just rip all the splint comments out of the prototypes for the ND output.
Thanks again.
2009-12-02 18:11:06 UTC by jasp1
