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 752657 - XML not documenting a class in python
XML not documenting a class in python
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.11-GIT
Other Linux
: Normal major
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2015-07-21 07:23 UTC by erez.oxman
Modified: 2015-12-30 10:20 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description erez.oxman 2015-07-21 07:23:50 UTC 
Hi, 

I'm trying to document the python package https://github.com/simplejson/simplejson, and looking on the xml output.

It does document many classes/functions, but misses key elements, like:

1) class JSONEncoder https://github.com/simplejson/simplejson/blob/master/simplejson/encoder.py#L89
2) class JSONDecoder https://github.com/simplejson/simplejson/blob/master/simplejson/decoder.py#L272

Tried in v1.8.9, didn't work, updated today to the latest git and still bug occurs.


If you need any more info regarding this issue I'll be happy to provide.

Thanks.
Comment 1 erez.oxman 2015-07-24 18:05:40 UTC 
Update:

1) These classes and their methods don't appear in the HTML output as well.

2) I've found a lead on where the bug is - 
if you remove the following lines of codes - https://github.com/simplejson/simplejson/blob/master/simplejson/encoder.py#L19-33
and rerun doxygen, it does correctly output "class JSONEncoder" and its methods.

Hope it helps.

Again, if there's any more info or tests I can do to help, please let me know.

Thanks.
Comment 2 albert 2015-07-26 09:59:52 UTC 
Problem looks like to be the double quote in a single quoted string, in this case in the definition of ESCAPE.

I've just pushed a proposed patch to github (pull request 372)
Comment 3 Dimitri van Heesch 2015-07-26 10:07:37 UTC 
Thanks, I've merged the pull request
Comment 4 Dimitri van Heesch 2015-12-30 10:20:07 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.11. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferably in the form of a self-contained example).