GNOME Bugzilla – Bug 568711
undocumented enum values are not reported
Last modified: 2009-12-26 22:38:09 UTC
If you add the following /** * GtkdocEnum: * * Here we document the enum but not the values. **/ typedef enum { GTKDOC_ENUM_1, GTKDOC_ENUM_2, } GtkdocEnum; to tests/gobject/src/gobject.h in gtk-doc source distribution and add GtkdocEnum to gobject/docs/tester-sections.txt and run `make check', it passes. It must not -- the documentation is incomplete. I stared into the code for quite some while and I am not sure how to fix this. Except that it seems related to line 3638 (or around): # FIXME: we need to check for empty docs here as well! The same problem might be with function arguments or struct members, I haven't checked that yet.
Good catch. Its unfortunately a bit more difficult. When using the tmpl build, we know from reading the templates whit parameters are expected. In the tmpl-free build, the list is empty and we can't know wheter there are none or there are some, but they are undocumented. I'll ry to figure out a way to get the needed info. For now there are a couple more FIXME:s in the code.
commit 08be8c069a717279f80357df2959a7195728b0b2 Author: Stefan Kost <ensonic@users.sf.net> Date: Sun Dec 27 00:30:33 2009 +0200 mkdb: track incomplete docs in tmpl-free build too. Fixes 568711 We reparse the structs/unions/enums for doc output anyway. Use that info to check if all fields/values have docs.