Doxygen for Python: How to generate documentation for nested functions

Question

I am documenting my Python code using Doxygen. The code makes use of Pythons capability of defining nested functions.

So I have documented them as if they were "normal" functions and set EXTRACT_ALL=YES.

But still, the nested functions cannot be found anywhere. Is there a way to make Doxygen do that?

(Doxygen version 1.8.6)

Joran Beasley · Accepted Answer · 2015-04-16 18:50:04Z

2

there is no way to access nested functions so im sure it just doesnt document it

 def wrapper():
    def nested(a,b,c):
        return a+b+c
    return nested(1,2,3)

 #a user can call wrapper()
 print wrapper()
 #but there is no way to call nested
 print nested(7,7,7) #ERROR!!!

since a user cannot call it why would you document it?

(really this is just a comment that was too long to post as a comment)

answered Apr 16, 2015 at 18:50

Joran Beasley

114k13 gold badges167 silver badges187 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Paddre Over a year ago

I want to document it because I want to provide full, nicely formatted documentation of my code for future developers and it would've been nice if Doxygen included it in its output

Frank V Over a year ago

Personally, I think it's a very important and valid point in answering the question.

Joran Beasley Over a year ago

@Paddre well I expect you are perhaps one of a very very small minority that wants this functionality. and lucky for you Doxygen is an opensource project so you can simply branch it and add that functionality (fair warning it is probably more work than this is worth)

Collectives™ on Stack Overflow

Doxygen for Python: How to generate documentation for nested functions

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related