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 363828 - python: module docstrings aren't handled correctly
python: module docstrings aren't handled correctly
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.1
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2006-10-21 03:26 UTC by Jason Ferrara
Modified: 2008-02-10 13:03 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
test case (2.87 KB, application/x-compressed-tar)
2006-10-21 03:27 UTC, Jason Ferrara 		  Details
Proposed patch (2.04 KB, patch)
2006-10-21 03:30 UTC, Jason Ferrara 		none Details | Review
A better patch (2.91 KB, patch)
2006-11-02 18:54 UTC, Jason Ferrara 		none Details | Review

Description Jason Ferrara 2006-10-21 03:26:35 UTC 
Docstrings found at the top of a source file should be used as the documentation for that module, but they're not.

Run the attached testcase and you'll see the brief and detailed documetation for MyModule is missing.
Comment 1 Jason Ferrara 2006-10-21 03:27:31 UTC 
Created attachment 75116 [details]
test case
Comment 2 Jason Ferrara 2006-10-21 03:30:37 UTC 
Created attachment 75117 [details] [review]
Proposed patch

I've run this on a large python project and it appears to work correctly, but I don't quite understand the intent behind the way some of code pyscanner.l is structured, so someone who does should make sure I haven't done something horribly wrong.
Comment 3 Kevin McBride 2006-11-01 17:53:45 UTC 
I confirm that 1.5.1 exhibits the behavior described in this bug.
Comment 4 Jason Ferrara 2006-11-02 18:03:37 UTC 
The patch I proposed above introduces a new bug, where documentation for class and module variables are ignored. I'm working on a better patch.
Comment 5 Jason Ferrara 2006-11-02 18:54:06 UTC 
Created attachment 75879 [details] [review]
A better patch

Doesn't have the bug the previous patch had.
Comment 6 Dimitri van Heesch 2007-12-30 13:21:27 UTC 
I don't think the fix proposed in the patch is the right way to do it. 
I'll include a less intrusive fix in the next subversion update.
Comment 7 Dimitri van Heesch 2008-02-10 13:03:18 UTC 
This bug was marked assigned, which means to should be fixed in version 1.5.5 of doxygen. Please verify if this is indeed the case, and if not, reopen the bug and provide additional information if possible.