Board index » cppbuilder » ANN: Doc-O-Matic 2 Preview Release 2 available for download

ANN: Doc-O-Matic 2 Preview Release 2 available for download

we are very happy to announce the first public beta version of Doc-O-Matic 2,
Preview Release 2. PR2 is available for immediate download at

   http://www.doc-o-matic.com/beta.shtml

Doc-O-Matic is a source code documentation system that understands how you
document source code. Doc-O-Matic generates output in different formats using
just one source.

This new version comes with an exciting set of new features such as

   * PDF output
   * Integrated Documentation Editor
   * Link Databases for automatic linking to VCL and MFC topics
   * many other exciting new features....

For a more complete list of new features and to download Doc-O-Matic now
please visit

   http://www.doc-o-matic.com/beta.shtml

If you have any questions about Doc-O-Matic, please send mail to
mailto:supp...@toolsfactory.com .

Best Regards
Markus
______________________________________________________________________
Markus Spoettl,
toolsfactory
news://forums.toolsfactory.com
http://www.toolsfactory.com

 

Re:ANN: Doc-O-Matic 2 Preview Release 2 available for download


Hi Markus,

Quote
> This new version comes with an exciting set of new features such as

>    * PDF output
>    * Integrated Documentation Editor
>    * Link Databases for automatic linking to VCL and MFC topics
>    * many other exciting new features....

So Doc-O-Matic allows now for out-of-source-documentation (external files)
without using Topic files? If yes then this would really be cool.

Ciao, Mike
--
Homepage: http://www.lischke-online.de
Delphi Unicode Center: http://www.delphi-unicode.net
GraphicEx: http://www.lischke-online.de/Graphics.html
Virtual Treeview: http://www.lischke-online.de/VirtualTreeview.html
Joint Endavour of Delphi Innovators (JEDI): www.delphi-jedi.org

Re:ANN: Doc-O-Matic 2 Preview Release 2 available for download


Hi Mike,

Quote
Mike Lischke wrote:
> So Doc-O-Matic allows now for out-of-source-documentation (external files)
> without using Topic files? If yes then this would really be cool.

I'm not sure I understand. What do you mean by out-of-source-documentation.
Doc-O-Matic uses Topic files for documentation do don't want to have in the
source directly (or HTML files alternatively). Using the link databases you
can treat existing external documentation (external means not in the
Doc-O-Matic project directly) just like native (native means topics contained
in the Doc-O-Matic project) documentation.

Does this answer your question?

Best Regards
Markus
______________________________________________________________________
Markus Spoettl,
toolsfactory
mailto:mar...@toolsfactory.com
http://www.toolsfactory.com

Re:ANN: Doc-O-Matic 2 Preview Release 2 available for download


Quote
> I'm not sure I understand. What do you mean by out-of-source-documentation.
> Doc-O-Matic uses Topic files for documentation do don't want to have in the
> source directly (or HTML files alternatively). Using the link databases you

I have not yet seen much of DOM and so far I have only seen that documentation
in source code is taken into the help file. I would like to write some extra
help say for each class, but not in source code.

Ciao, Mike

Re:ANN: Doc-O-Matic 2 Preview Release 2 available for download


In article <3b719126_1@dnews>, pub...@lischke-online.de says...

Quote
> > I'm not sure I understand. What do you mean by out-of-source-documentation.
> > Doc-O-Matic uses Topic files for documentation do don't want to have in the
> > source directly (or HTML files alternatively). Using the link databases you

> I have not yet seen much of DOM and so far I have only seen that documentation
> in source code is taken into the help file. I would like to write some extra
> help say for each class, but not in source code.

You can add topic files to a documentation project which contain
documentation for pretty much anything you like, but which will be
included in the automatic topic linking etc that is applied to in source
comments.

Topic files are just as easy to write, if not more so, than embedded
documentation, and support all of the tagging and auto-interpretation
benefits that in-line comments are treated to.

I use this to document interfaces in COM type libraries.

You can't embed documentation for these in the _TLB.pas, and documenting
the implementation of interfaces is not practical (nor what is
required).  But the symbols get linked automatically to the relevant
topics in my implementation classes and indeed to the TLB unit
documentation itself.

--
Jolyon Smith
Neot Software Services Ltd.
http://www.neot.co.uk

Re:ANN: Doc-O-Matic 2 Preview Release 2 available for download


Hi Jolyon,

Quote
> You can't embed documentation for these in the _TLB.pas, and documenting
> the implementation of interfaces is not practical (nor what is
> required).  But the symbols get linked automatically to the relevant
> topics in my implementation classes and indeed to the TLB unit
> documentation itself.

This sounds good. Thank you for the explanantion. I'm going to evaluate
Doc-o-Matic.

Ciao, Mike

Other Threads