Re: de facto documentation tool

GenHelp works in both methods.
It *can* import source code comments to document your
code but can also import the code and allow you to add
your own documentation. Re-importing code when changes
are made to the code does *not* affect the documentation.
GenHelp is also cheaper than DocOMatic (but does less)
and supports C++/C#/Delphi in one product.
--
HTH Pete
=================================
www.frasersoft.net
GenHelp: "Making writing help fun"


"Brian Moelk" <bmoelk@xxxxxxxxxxxxxxxxxxxxxxxxxxxx> wrote in message
news:43f4abf1$1@xxxxxxxxxxxxxxxxxxxxxxxxx
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: 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: Literate Programming in Ada, AdaDoc, AdaBrowse
    ... > documentation accompanying open source Ada projects. ... > Literate programming is a fancy way of documenting source code. ... > comments in an Ada source file. ... development on AdaDoc seems to have stopped (since ...
    (comp.lang.ada)
  • 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)