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

[Damon Chaplin <damon karuna uklinux net>]

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