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 735152 - Python: Allow undocumented "cls" parameter for class methods
Python: Allow undocumented "cls" parameter for class methods
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.7
Other All
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2014-08-21 11:47 UTC by mgeis
Modified: 2015-12-30 10:20 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description mgeis 2014-08-21 11:47:42 UTC 
In Python, there is a convetion to use "self" as the first parameter for instance methodsand "cls" as the first parameter in class methods.

Doxygen allows an undocumented "self" parameter in Python.

My suggestion is that Doxygen should also allow an undocumented "cls" parameter in Python.
Comment 1 albert 2015-12-26 14:32:06 UTC 
I've just pushed a proposed patch to github (pull request 430)
Comment 2 albert 2015-12-26 18:03:04 UTC 
Changes have been integrated in github master version
Comment 3 Dimitri van Heesch 2015-12-30 10:20:27 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).