Short & long description sections.



I am documenting the gnome atk accessability toolkit using gtk-doc to generate 
the html API reference.
Is it correct that the text for the short and long desciption settings which 
appears in the final generated html files must be added to the sgml files in the 
tmpl directory after the 'make templates' step?
Or is it possible to add the descriptions in the source code as a comment block 
and have gtk-doc automatically extract the descriptions (in the way it extracts 
function descriptions, parameter descriptions etc.)?
If so, what format should the long and short descriptions be written in comment 
blocks in source files (are tags such as 'description:' or '@description:' 
used)?

Any help appreciated,

******************************************************
Oisin Boydell
Sun Microsystems Ireland
Phone: +353 (0)1 8199778
Mobile: +353 (0)86 3045117
******************************************************





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