Re: [Babeldoc-devel] Adding examples to User Guide?

[Dejan K. <dej...@nb...>]

Hi David,
Currently is pretty dificult to do such thing since documentation is
autogenerated. Maybe you can add examples to description section? If you
want to do that,  you can edit source code or even better message resources.
All pipeline stages has getInfo() method which returns IConfigInfo object
with meta information about that stage. Scanner worker and pipeline stage
documentation is generated using this metainformation. In current
implementation every pipeline stage in its constructor calls super
constructor with IConfigInfo parameter. One of methods of object that is
sent to super constructor is getDescription() method which returns String
with stage description.

Anyway, most of examples in current distribution are in examples folder. So
maybe you would like to put them there....

Dejan

----- Original Message -----
From: "David Glick" <dg...@co...>
To: <bab...@li...>
Sent: Friday, August 15, 2003 2:09 AM
Subject: [Babeldoc-devel] Adding examples to User Guide?


> Hi Bruce,
>
> I'd like to add examples to the Users Guide to cover at the least the
issues
> that I faced coming up to speed with some of these stages. I'd like to add
> the examples in the Pipeline stage types section to keep them with the
stage
> they illustrate.  However, it looks like this section is auto-generated
from
> the source.  How would you recommend I proceed?
>
>
> Thanks,
>
> David
>
> --
> David Glick
> Transmit Consulting, Inc
> 619-475-4052
> dg...@tr...
>
>
>
> -------------------------------------------------------
> This SF.Net email sponsored by: Free pre-built ASP.NET sites including
> Data Reports, E-commerce, Portals, and Forums are available now.
> Download today and enter to win an XBOX or Visual Studio .NET.
>
http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01
> _______________________________________________
> Babeldoc-devel mailing list
> Bab...@li...
> https://lists.sourceforge.net/lists/listinfo/babeldoc-devel