Preferred way of putting title in section

[Krzesimir Nowak]

Hi,

which way of putting title of section is preferred?
1. `@title: my title' in SECTION comment in source code.
2. `<TITLE>my title</TITLE> in package-sections.txt.

There is a FIXME in `Documenting section' in gtk-doc manual about this.
It would be good to have it clarified.

Thanks,
Krzem

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list

[David Nečas (Yeti)-2]

On Wed, Sep 02, 2009 at 12:46:56AM +0200, Krzesimir Nowak wrote:
> which way of putting title of section is preferred?
> 1. `@title: my title' in SECTION comment in source code.
> 2. `<TITLE>my title</TITLE> in package-sections.txt.
>
> There is a FIXME in `Documenting section' in gtk-doc manual about this.
> It would be good to have it clarified.

The former because package-sections.txt can be (and should be) generated
nowadays with gtkdoc-scan --rebuild-sections if you have sanely
organized header files.

Yeti

_______________________________________________
gtk-doc-list mailing list
gtk-doc-list@...
http://mail.gnome.org/mailman/listinfo/gtk-doc-list