up vote 0 down vote favorite
share [g+] share [fb]

Doxygen get me docs similarly to

http://www.stack.nl/~dimitri/doxygen/examples/pyexample/html/classpyexample_1_1PyClass.html

But I want to see Functions with parameters similarly to c/c++.

Is there some settings for that?

link|improve this question
64% accept rate
2  
Doesn't it show parameters?! It shows self after all, which is an ordinary parameter. And generally, doxygen is a somewhat unusual choice to document Python project. In years of Python programming I haven't seen a single project that uses doxygen for documentation. Why don't you just use standard, well-known documentation tools like epydoc or Sphinx? – lunaryorn Dec 13 '11 at 19:36
feedback

1 Answer

up vote 1 down vote

If I understand the OPs question he has some functions within a module which are not member functions of any class and wants to document these with doxygen. This is possible and one way to do it is to add 

 ##
 # @namespace your_package.your_module
 # ...

at the top of the module and then document each function similar to:

 ##
 # @brief Brief description...
 # 
 # @param x   the x parameter
 # @param y   the y parameter
 def my_func(x,y):
     pass

Doxygen will also pick up the Python doc strings but that is more limited in that you cannot use all of Doxygen's tags

link|improve this answer
see also: stackoverflow.com/questions/8375631/… – Paul Joireman Dec 15 '11 at 19:59
feedback

Your Answer

 
or
required, but never shown
discard

Not the answer you're looking for? Browse other questions tagged or ask your own question.