Hi,

          http://sphinx.pocoo.org/
            - Documentation format

Viktor, can you add some comment about this documentation system. Does Sphinx parses source files? Can it parse .prg code?

I'm used to see to sources, but sometimes it would be more quick to look to docs for function parameters, etc. I've looked to utils/hbdoc, but could not make anything, because hbdoc.exe requires some Norton Guide link file, I was not able to find one in SVN.


I've also tried to look at a few documentation systems:
1) Robodoc creates manual using ugly "section/subsection" headings.
2) Doxygen is oriented to object oriented programming style. It tries to document classes, methods, etc., but no documentation for functions. Though, I was able to manage documentation of functions by including it into modules. Doxygen analyses code itself (not only documentation inside comments), so, it is unable to parse unsupported programming language (i.e. PRG code).


Writing a simple source parser (parses documentation tags inside comments), it's a few hours job. I think we need one for function documentation.



Best regards,
Mindaugas
_______________________________________________
Harbour mailing list
Harbour@harbour-project.org
http://lists.harbour-project.org/mailman/listinfo/harbour

Reply via email to