Home/ Questions/Q 184751
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-11T15:20:52+00:00

How do I produce Qt-style documentation (Trolltech’s C++ Qt or Riverbank’s PyQt docs) with

  • 0

How do I produce Qt-style documentation (Trolltech’s C++ Qt or Riverbank’s PyQt docs) with Doxygen? I am documenting Python, and I would like to be able to improve the default function brief that it produces.

In particular, I would like to be able to see the return type (which can be user specified) and the parameters in the function brief.

For example:

 Functions:       int getNumber(self)      str getString(self)      tuple getTuple(self, int numberOfElements=2)   Function Documentation:       int getNumber(self)             gets the number of items within a list as specified...             Definition at line 63 of ....       etc...

If this isn’t possible without modifying the source, maybe there is another tool other than Doxygen that handles Python documentation in this kind of way?

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Then just use Doxygen? This will get you started:

    This is a guide for automatically generating documentation off of Python source code using Doxygen.

    Obviously, since Python is not strongly typed, specifying the return type and the expected type of the parameters will be up to you, the documentation writer. That’s just best practices anyway.

    • 0