Doxygen end of line comments declarations in Python

In C / C ++, you can make doxygen recognize that the comment applies to the text preceding it in the line. Any of them:

int my_variable; /*!< This is my variable */ int my_variable; /**< This is my variable */ int my_variable; //!< This is my variable int my_variable; ///< This is my variable 

Adds a string to the documentation for my_variable . The equivalent attempt in Python does not seem to work. It works:

 ## This is my variable my_variable = None 

It:

 my_variable = None ## This is my variable my_other_variable = None 

attaches the documentation to my_other_variable , as you would expect, but both of them:

 my_variable = None ##< This is my variable my_variable = None #!< This is my variable 

seems to just cancel the documentation. Is there a way to make the equivalent //!< In Python?

+2
source share
1 answer

No, this is not currently supported.

A parser for Python was provided by several students. Despite the fact that they did an excellent job, they did not implement all the functions available for C / C ++.

The two most noticeable features that are missing:

Hope I can add them in the future, but any help is appreciated.

+7
source

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


All Articles