gtkdoc not using documentation
- From: Stefan Kost <kost imn htwk-leipzig de>
- To: gtk-doc-list gnome org
- Subject: gtkdoc not using documentation
- Date: Wed, 22 Dec 2004 14:54:26 +0100
hi hi,
I just had another go at compleeting the gstreamer docs and I am getting these
warnings, although as you can see below the entries *are* documented.
The warning is issued in gtkdoc-mkdb:MergeSourceDocumentation():2520
I've submitted a patch under
http://bugzilla.gnome.org/show_bug.cgi?id=161979
that changes the warning to show the real type of the symbol ('Func:' -> 'ENUM:').
Still I have no idea, how to debug, why it is not using the provided
documentation. Any ideas?
Ciao
Stefan
------
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_READONLY.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_SUBBUFFER.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_ORIGINAL.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_DONTFREE.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_KEY_UNIT.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_DONTKEEP.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_IN_CAPS.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_DELTA_UNIT.
WARNING: Parameter description missing in source code comment block -
Func: GstBufferFlag Param: GST_BUFFER_FLAG_LAST.
------
/**
* GstBufferFlag:
* @GST_BUFFER_READONLY: the buffer is read-only.
* @GST_BUFFER_SUBBUFFER: the buffer is a subbuffer, the parent buffer can be
* found with the GST_BUFFER_POOL_PRIVATE() macro.
* @GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer.
* @GST_BUFFER_DONTFREE: do not try to free the data when this buffer is
* unreferenced.
* @GST_BUFFER_KEY_UNIT: the buffer holds a key unit, a unit that can be
* decoded independently of other buffers.
* This flag has been deprecated, see #GST_BUFFER_DELTA_UNIT.
* @GST_BUFFER_DONTKEEP:
* @GST_BUFFER_IN_CAPS: the buffer has been added as a field in a #GstCaps.
* @GST_BUFFER_DELTA_UNIT: this unit cannot be decoded independently.
* Since 0.8.5
* @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
*
* A set of buffer flags used to describe properties of a #GstBuffer.
*/
typedef enum {
GST_BUFFER_READONLY = GST_DATA_READONLY,
GST_BUFFER_SUBBUFFER = GST_DATA_FLAG_LAST,
GST_BUFFER_ORIGINAL,
GST_BUFFER_DONTFREE,
GST_BUFFER_KEY_UNIT, /* deprecated, use reverse DELTA_UNIT */
GST_BUFFER_DONTKEEP,
GST_BUFFER_IN_CAPS,
GST_BUFFER_DELTA_UNIT, /* this unit depends on a previous unit */
GST_BUFFER_FLAG_LAST = GST_DATA_FLAG_LAST + 8
} GstBufferFlag;
--
\|/ Stefan Kost
<@ @> private business
+-oOO-(_)-OOo------------------------------------------------------ - - - - -
| __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach 301166
| /// 04277 Leipzig 04251 Leipzig
| __ /// Germany Germany
| \\\/// Phone +49341 2253538 +49341 30766101
| \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
| WWW www.sonicpulse.de www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - - - -
begin:vcard
fn:Stefan Kost
n:Kost;Stefan
org:HTWK Leipzig;FB. IMN
adr:;;Postfach 301166;Leipzig;;04251;Germany
email;internet:kost imn htwk-leipzig de
title:Dipl. Informatiker
tel;work:+49341 30766440
tel;home:+49341 2253538
tel;cell:+49178 3183742
x-mozilla-html:FALSE
url:http://www.imn.htwk-leipzig.de/~kost/about.html
version:2.1
end:vcard
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]