After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 512565 - add GTK_DOC_IGNORE
add GTK_DOC_IGNORE
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: 1.16
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2008-01-28 14:12 UTC by Benjamin Otte (Company)
Modified: 2010-09-13 11:16 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Benjamin Otte (Company) 2008-01-28 14:12:14 UTC
It would be nice if there was a way to tell gtk-doc to not parse parts of headers or source files.
I had thought about using #ifndef GTK_DOC_IGNORE which would make gtk-doc ignore everything up to the matching #endif.

This would improve 2 things:
1) working around gtk-doc bugs (they sometimes do happen, really!)
2) converting undocumented code to gtk-doc
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2010-09-13 11:16:59 UTC
commit 2ae6867592017bb83b39c3be201e842cf77fc1f7
Author: Stefan Kost <ensonic@users.sf.net>
Date:   Mon Sep 13 14:14:08 2010 +0300

    scan: provide a way to skip unparsable code
    
    Allow to use #ifndef __GTK_DOC_IGNORE__ to mark unparseable code.
    Fixes #512565.