Difference between revisions of "User:Jayt"
Jump to navigation
Jump to search
(better wikify.py script) |
PraetorFenix (talk | contribs) (doxygen?) |
||
Line 24: | Line 24: | ||
Updated to output better wikicode. --[[User:Jayt|Jayt]] 21:56, 13 June 2006 (UTC) | Updated to output better wikicode. --[[User:Jayt|Jayt]] 21:56, 13 June 2006 (UTC) | ||
+ | ---- | ||
+ | Hello, | ||
+ | |||
+ | Since you are documenting the source code, you may want to consider | ||
+ | [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen] (pronounced docs-gen) for annotations. | ||
+ | |||
+ | Here is an [http://docs.genecys.org/client/index.html example] of how doxygen generates and collates comments in source files. | ||
+ | |||
+ | -- [[User:PraetorFenix|PraetorFenix]] 07:07, 17 June 2006 (UTC) |
Revision as of 07:07, 17 June 2006
Hi fellow Hackers! Now that this wiki has some proper admins, I feel better about spending time contributing to it (before, we had spam attacks and couldn't do anything about them). Hopefully this will develop into a solid resource for dungeoneers the world over! --Jayt 23:24, 4 June 2006 (UTC)
Here are my thoughts on completeness
Source wikification script
#!/usr/bin/python #Usage: ./wikify.py sourcefile.c > sourcefile.c.wiki import sys f = open(sys.argv[1]) i=1 print 'Below is the full text to src/' + sys.argv[1] + ' from NetHack \ 3.4.3. To link to a particular line, write [[' + sys.argv[1] + \ '#line123|[[' + sys.argv[1] + '#line123]]]], for example.' for line in f.readlines(): print ' <span id="line' + str(i) + '">' + \ (str(i) + '.').ljust(6)+line.rstrip("\n")+'</span>' i += 1
--Jayt 18:39, 12 June 2006 (UTC)
Updated to output better wikicode. --Jayt 21:56, 13 June 2006 (UTC)
Hello,
Since you are documenting the source code, you may want to consider Doxygen (pronounced docs-gen) for annotations.
Here is an example of how doxygen generates and collates comments in source files.
-- PraetorFenix 07:07, 17 June 2006 (UTC)