GNOME Bugzilla – Bug 568732
missing long descriptions undetected
Last modified: 2009-01-26 16:45:17 UTC
Missing long description are not noticed. This can be tested by removing the body of SECTION:object in tests/gobject/src/gobject.c in gtk-doc source code. After that, `make check' still passes, but it must not. A patch is attached, with two remarks: - is this the right place to fix this? - I need to do `make install' for patch or patch -R to make any difference, ATM I don't know if it's problem in my setup or in make check generally A more general note, the test cases in gtk-doc should check not just how it deals with 100% documentation, but also whether can detect *problems* in the documentation.
Created attachment 127016 [details] [review] tentative patch
The patch as such makes sense. I'll have a look into the test setup. Regarding the needed "make install". have you rerun autoregen.sh, I recently made fixes to stupid things I did in the local makefiles for the tests. They actually should run the uninstalled tools now. Then regarding the tests, totally agree. More tests are needed. I'll have to look into adding a suite, where we can assert that error are produced.
I just did ... * @short_description: class for gtk-doc unit test *//* * ... and with the patch applied the tests fail. So I'd say the patch fixes it. \o/ 2009-01-23 Stefan Kost <ensonic@users.sf.net> patch by: David Nečas <yeti@physics.muni.cz> * gtkdoc-mkdb.in: Don't add empty <para></para> tags to the docs to avoid breaking the detection of undocumented things. Fixes #568732.
No, there is something more deeply rotten here. If I remove just the long description, the missing documentation is detected now. But if I remove the section comment in tests/gobject/src/gobject.c *completely* then `make check' still passes.
2009-01-26 Stefan Kost <ensonic@users.sf.net> * gtkdoc-mkdb.in: * tests/bugs/src/tester.h: * tests/fail.sh: * tests/fail/docs/tester-docs.xml: * tests/fail/docs/tester-sections.txt: * tests/fail/src/tester.c: Add public symbols from section file when doing the -undocumented.txt report. Also add the special symbols for the section docs when reading the section-file. Extend test suite to check for it. Fixes #568732