Now I need to document it, so I won't forget what I wrote when I'll come back to the code, 2-6 months later.
After a short research I've found this very nice documentation tool:
ROBODoc 4.99.40 User Manual
and here is an example config file (you'll need it later) I wrote (modified from this source: http://qe-forge.org/cgi-bin/cvstrac/q-e/fileview?f=espresso/GUI/Guib/doc/robodoc.rc&v=1.3)...
options: --src ../ --doc ./api/printable/TBD-api --internal --html --singledoc --sections --toc --tabsize 4 --index --nopre --documenttitle "TBD -- To Be Defined." --sectionnameonly --syntaxcolors_enable quotes,line_comments,block_comments,keywords,non_alpha accept files: *.lua ignore files: .svn doc headertypes: e "Enums" robo_sections ignore items: item order: FUNCTION SYNOPSIS INPUTS RETURN VALUE source items: SYNOPSIS header markers: --**** remark markers: -- end markers: --**** remark begin markers: -- remark end markers: -- keywords: and break do else elseif end false for function if in local nil not or repeat return then true until while source line comments: --
No comments:
Post a Comment