Re: where to put documentation for defines, structs (gobject classes), enums etc.



On Thu, May 13, 2004 at 12:17:24PM +0100, Damon Chaplin wrote:
> On Thu, 2004-05-13 at 10:13, Stefan Kost wrote:
> > ... and another answer,
> > 
> > it sometimes helps to do 'rm docs/reference/*.stamp'.
> > The defines, structs and so on can be documented in the source ;-)
> > Remains the question, if these sections can be documented in the source?
> > ##### SECTION Title #####
> > ##### SECTION Short_Description #####
> > ##### SECTION Long_Description #####
> > ##### SECTION See_Also #####
> > And if so how? When looking at gtkdoc-scan it look like it extracts 
> > comments for MACROS, TYPEDEF'D FUNCTIONS, ENUMS, STRUCTS, UNIONS, 
> > VARIABLES (extern'ed variables), FUNCTIONS.
> > Is it gtkdoc-mktmpl that actually extracts data from source comments?
> 
> ReadSourceDocumentation() in gtkdoc-mkdb is where the source code is
> scanned for documentation.
> 
> It would be nice if all docs could be included in the source code if
> desired.
> 
> Damon

Filed in bugzilla.g.o as number 142647
( http://bugzilla.gnome.org/show_bug.cgi?id=142647 )


Cheers
Geert Stappers

Attachment: pgp1KssFDzdnx.pgp
Description: PGP signature



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