Re: [gnome-db] Creating Mallard documentation for LIBGDA

On 4 June 2010 18:53, Daniel Espinosa <esodan gmail com> wrote:
> I'm starting to write some documentation for GDA, but I don't found how link
> them to the library reference (the one DevHelp shows).
> The mallard proyect home page, I think, describe how to write guides with
> topics, but I don't fine how to link it to gtk-doc reference documentation.

AFAIK you need a viewer to view the documentation writen using
Mallard's syntax. In the case of the GdaBrowser, the doc. is displayed
using yelp (when the user asks for help from the main menu).

The documentation generated by gtkdoc is a reference doc and displayed
when the developper needs it, usually in DevHelp, or as HTML or for
example within Anjuta (it can even be converted to a big PDF).

I don't know what kind of ducumentation you want to write, but you
probably first want to decide how and by whom it will be used and then
see how it should technically be done.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]