Re: Warning in XML build phase

[Stefan Kost <ensonic hora-obscura de>]

Am 29.10.2010 15:49, schrieb Emmanuel Pacaud:
> Hi,
> 
> I've added gtk-doc support to the Lasem library
> (http://git.gnome.org/browse/lasem/). But when I build the
> documentation, I've got a the following warnings:
> 
> gtk-doc: Running scanner lasem-scan
> gtk-doc: Building XML
> :0: warning: Field descriptions for LsmSvgRadialGradientElementClass are
> missing in source code comment block.
> :0: warning: Value descriptions for LsmMathmlRadicalElementType are
> missing in source code comment block.
> :0: warning: Field descriptions for LsmMathmlRadicalElementClass are
> missing in source code comment block.
> :0: warning: Field descriptions for LsmSvgTspanElementClass are missing
> in source code comment block.
> :0: warning: Field descriptions for LsmSvgLinearGradientElementClass are
> missing in source code comment block.
> :0: warning: Field descriptions for LsmMathmlDocumentClass are missing
> in source code comment block.
> :0: warning: Field descriptions for LsmSvgPatternElementClass are
> missing in source code comment block.
> 
> ...And a lot more...


Your section.txt file looks wrong.
http://git.gnome.org/browse/lasem/tree/docs/reference/lasem/lasem-sections.txt

Change e.g.
<SECTION>
<FILE>lsmmathmlradicalelement</FILE>
<TITLE>LsmMathmlRadicalElement</TITLE>
LsmMathmlRadicalElementType
LsmMathmlRadicalElementClass
LsmMathmlRadicalElement
lsm_mathml_root_element_new
lsm_mathml_sqrt_element_new
<SUBSECTION Standard>
LSM_MATHML_RADICAL_ELEMENT
LSM_IS_MATHML_RADICAL_ELEMENT
LSM_TYPE_MATHML_RADICAL_ELEMENT
lsm_mathml_radical_element_get_type
LSM_MATHML_RADICAL_ELEMENT_CLASS
LSM_IS_MATHML_RADICAL_ELEMENT_CLASS
LSM_MATHML_RADICAL_ELEMENT_GET_CLASS
</SECTION>

to

<SECTION>
<FILE>lsmmathmlradicalelement</FILE>
<TITLE>LsmMathmlRadicalElement</TITLE>
LsmMathmlRadicalElement
lsm_mathml_root_element_new
lsm_mathml_sqrt_element_new
<SUBSECTION Standard>
LsmMathmlRadicalElementType
LsmMathmlRadicalElementClass
LSM_MATHML_RADICAL_ELEMENT
LSM_IS_MATHML_RADICAL_ELEMENT
LSM_TYPE_MATHML_RADICAL_ELEMENT
lsm_mathml_radical_element_get_type
LSM_MATHML_RADICAL_ELEMENT_CLASS
LSM_IS_MATHML_RADICAL_ELEMENT_CLASS
LSM_MATHML_RADICAL_ELEMENT_GET_CLASS
</SECTION>

If you don't put e.g. LsmMathmlRadicalElementClass, gtk-doc naturally expects
you to document it :)

Stefan


> 
> I don't understand the meaning of this warnings, as I didn't have
> documented these structures at all.
> 
> Any idea ?
> 
> Thanks in advance,
> 
> Emmanuel.
> 
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list