New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XML not documenting a class in python (Origin: bugzilla #752657) #5830

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity major in component general for ---
Reported in version 1.8.11-GIT on platform Other
Assigned to: Dimitri van Heesch

On 2015-07-21 07:23:50 +0000, erez.oxman@gmail.com wrote:

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.

On 2015-07-24 18:05:40 +0000, erez.oxman@gmail.com wrote:

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.

On 2015-07-26 09:59:52 +0000, albert wrote:

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)

On 2015-07-26 10:07:37 +0000, Dimitri van Heesch wrote:

Thanks, I've merged the pull request

On 2015-12-30 10:20:07 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment