Re: de facto documentation tool

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)

That's a nice feature indeed. The question I have now is if it can
regenerate the method/property stubs without clobbering existing
documentation. IOW, how does it manage change over time. I would hope that
it would be fine...but you never know. ;)

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

I've heard the same regarding doc-o-matic. The main issue for me with these
higher end products is their price point, and for me since application help
is much more important than code help my money is going to be spent on
applications like Help and Manual, Help Scribble, etc.

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)

It would be nice if the IDE could pull in that help/documentation
information in some way, or let you edit it in a *separate* docked or popup
window (I personally dislike modal dialogs). However the IDE manages this
is up to the IDE and/or the plug in, that doesn't matter so much as long as:
1) documentation is available for viewing/editing; 2) documentation is
separate from code; 3) documentation stubs are regenerated from the code
itself without losing existing documentation. Perhaps, this could be
integrated into the fly-over help stuff, I'm not sure though.

--
Brian Moelk
bmoelk@xxxxxxxxxxxxxxxxxxxxxxxxxxxx
http://www.brainendeavor.com


.

Relevant Pages

  • Re: de facto documentation tool
    ... use javadoc style or XML style or any other de facto style? ... same source code and build multiple help files (you have to create one T2H ... I believe Doc-O-Matic also has a concept of storing documentation in ... Do you mean an editor which displays for each source code "item", ...
    (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: Cobol work?
    ... Other languages have commenting ... >> documentation is not part of the usual teaching method. ... > characters long), and restrictions such as variables whose type were integer ... and external identifiers have only 31 ...
    (comp.lang.cobol)
  • 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)