Re: GNOME API Documents, formatting issues

[Scott Wimer <scottw dev cgibuilder com>]

John,

The description of the function lives to the right of the function name.
I'm hoping to add a section to the docu-comment block (in the src) that
provides for a usage example.  The example would be the last block in
the generated documentation.  There will also be a link made to the 
lxr entry for each function.  For those who are online, that'll be nice
and handy.

regards,
scottwimer

On Fri, 6 Nov 1998, John R Sheets wrote:

> Scott Wimer wrote:
> 
> > Well, I've managed to get some more work done on the API document
> > extraction stuff.  I'm still not exactly sure what the end result
> > format of this stuff is going to be (in terms of layout).  So, I
> > threw together a plugin that formats into HTML in a manner that I
> > think is relatively usable.
> 
> Looks pretty good.  One question, though: wasn't there a second, longer
> description possible in the docu-comment block?  I didn't see any in your
> sample (probably just didn't happen to exist in your code sample).  Would
> the long description show up as a separate block at the end of the table?
> 
> John
> 
> 
> 
> -- 
>          To unsubscribe: mail gnome-list-request@gnome.org with 
>                        "unsubscribe" as the Subject.
> 
> 

--
Scott Wimer
play  --->    scottw@cgibuilder.com         http://www.cgibuilder.com/
work  --->    scottw@corp.earthlink.net     http://www.earthlink.net/