Generating documentation from C source code
Par jd le mercredi, janvier 16 2008, 08:18 - Free Software - Lien permanent
Dear Lazy Web,
I'm looking for a tool to extract and generate user documentation from C source code. No, I don't want doxygen which I already use, but something that can extract comments from C source and print them to a text file. The ultimate goal is to generate manpages (using asciidoc).
Anything that may look like that, a program, a library or a trained poney might interest me.
Commentaires
http://packages.debian.org/sid/c2ma...
With a big warning
lp4all :
https://gna.org/projects/lp4all/ http://www.linux-france.org/~dmentr...
Work still in (very slow) progress, somewhat stalled but not abandoned.
You said "anything"...
Umh.. I'm not sure that'd be useful for most of the code I've written
Of course, being a Perl guy, I tend to document my code in POD. And if you just filtered my comments, you'd find such jewels as (picked almost randomly):
raise_error is true
raise_error is false
raise_error is true again
raise_error is false again
or
Were we called as an instance method and not as a class method? Ok, go
ahead
Check if we know how our table is laid out. If %dbfields (class variable)
is empty, populate it.
Were we requested the results to be sorted? Take the key out of the
%vals array, and check if it is valid.
If we got no attributes, we are searching for a list of all persons
We are performing a search on specific attributes
Text fields will be searched by regular expression matching. All
other fields will look for exact equality.
No placeholder - Remove the attribute
from the list
We just want the list of all persons
If $max_props is 0, we have no limit set - The person can submit.
Make it work regardless if it was called as a class or an instance
method
If the password is not valid, return undef
Of course, now that I'm moving over to RubyLand, and given that RDOC is so braindead it wants to read your comments... My commenting style must change
Come on !! http://www.cenqua.com/commentator/