Qt style documentation using Doxygen?

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

In particular, I would like to see the return type (which can be specified by the user) and the parameters in short form.

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 is not possible without changing the source, is there perhaps a tool other than Doxygen that processes Python documentation this way?

+3
source share
4 answers

Then just use Doxygen? This will help you get started :

Python Doxygen.

, Python , , . , .

+2

- , Python, Sphinx. , python .

+1

, , qt-.
, qt qhelpgenerator, .qch, qt.
, .

0
source

You do not need to specify doxygen comments in the code. You can post documentation in other places. Check out this page in the doxygen manual.

0
source

Source: https://habr.com/ru/post/1706880/


All Articles