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 303337 - gtk-doc doesn't parse and handle functions returning explicit enums
gtk-doc doesn't parse and handle functions returning explicit enums
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.4
Other All
: High normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2005-05-07 07:03 UTC by Dodji Seketeli
Modified: 2005-09-15 14:59 UTC
See Also:
GNOME target: ---
GNOME version: 2.11/2.12


Attachments
A patch that fixes the bug for me (4.07 KB, patch)
2005-05-07 07:05 UTC, Dodji Seketeli
none Details | Review

Description Dodji Seketeli 2005-05-07 07:03:28 UTC
Please describe the problem:
A function like:

enum FooEnum 
my_function ()
{
}

is not parsed by gtk-doc. So, the comments for such functions are not
reported in the documentation produced by gtk-doc.

Functions with arguments of type "enum foo an_argument" are not parsed either.
gtk-doc expects that enums are defined as:
typedef enum _FooEnum { /*blah*/ } FooEnum ;


Steps to reproduce:
1. 
2. 
3. 


Actual results:


Expected results:
I would expect gtk-doc to correctly parse declarations where the enum
keyword is explicitely specified.

Does this happen every time?
yes

Other information:
Comment 1 Dodji Seketeli 2005-05-07 07:05:49 UTC
Created attachment 46122 [details] [review]
A patch that fixes the bug for me

This patch seems to fix the problem for me.
It just completes the regexps used to parse function declarations and
arguments so that they accepts enums where the 'enum' keyword is explicitely
specified.
Comment 2 Brent Smith (smitten) 2005-07-19 21:16:28 UTC
this is still an issue in CVS HEAD, marking version 1.4, GNOME Version 2.11/2.12
patch is a little bit out of date, marking priority high to get patch reviewed.
Comment 3 Damon Chaplin 2005-09-15 14:59:03 UTC
patch applied. thanks