Re: de facto documentation tool

Brian Moelk wrote:
It would be nice, if anyone could share any thoughts. Also, do you
use javadoc style or XML style or any other de facto style? TIA

Some options:

http://www.zeitungsjunge.de/delphi/pasdoc/
http://pasdoc.sipsolutions.net/PasDoc
http://www.time2help.com
http://www.doc-o-matic.com

I don't like mixing documentation comments with code comments, but
that seems to be the standard way of doing things. I personally
would like to have external stub files that can be regenerated and
localized;

Time2HELP has a concept of UnitDoc files, which are separate xml files which
it can synchronize against the structure of the units they document.
This way, it is possible to have UnitDocs in different languages for the
same source code and build multiple help files (you have to create one T2H
project for each help file (language) you want)

I believe Doc-O-Matic also has a concept of storing documentation in
external files, but I don't know the details.

and then IDE integration of these external files.
I've never seen such a beast.

Do you mean an editor which displays for each source code "item", all the
"variants" (translations) of the documentation for it?
(I've never seen that feature in this specific kind of application)

Cheers,
Jarle


.

Relevant Pages

  • Re: de facto documentation tool
    ... it is possible to have UnitDocs in different languages for the ... same source code and build multiple help files (you have to create one T2H ... Do you mean an editor which displays for each source code "item", ... "variants" of the documentation for it? ...
    (borland.public.delphi.non-technical)
  • Re: TeX and friends
    ... There is a core of a Unix OS in the foundations, ... which does of course mean that it's easy to write a nice integrated GUI ... but what about when you can't write any documentation at all ... the source code is ...
    (uk.people.support.depression)
  • Re: Doc-O-Matic 3.7 released - Source Documentation System
    ... > Doc-O-Matic 3.7 is the latest version of our Source Code Documentation ... > PDF, HTML Help, Help 2 and Windows Help. ... > Markus Spoettl, ...
    (microsoft.public.dotnet.languages.vb)
  • Re: PIC/Linux
    ... and some documentation, shell scripts, etc., but nothing that needs to be made. ... and got a complaint that it couldn't find simulavr. ... I decided it would be helpful to look at the source code for the ... cpio --extract to extract the contents of the cpio file. ...
    (sci.electronics.misc)
  • Re: Python style: exceptions vs. sys.exit()
    ... So what's wrong with using the source as documentation? ... But when it comes to nitty-gritty details, source code is the ... language you don't understand (e.g. Python built-ins are written in C, ... language you understand and not too complicated for you to grasp, ...
    (comp.lang.python)