3

In C/C++, you can force doxygen to recognize that a comment applies to the text preceding it on a line. Any of these:

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 the string to the documentation for my_variable. Trying the equivalent in Python doesn't seem to work. This works:

## This is my variable
my_variable = None

This:

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

attaches the documentation to my_other_variable, as you'd expect, but both of these:

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

seem to just discard the documentation. Is there a way to do the equivalent of //!< in Python?

1
  • As far as I can tell this is now working in doxygen as of version 1.9.7 (i.e. the ##< variant). Commented Jun 3, 2024 at 16:43

1 Answer 1

9

No, at the moment this is not supported.

The parser for Python was provided by a couple of students. While they did a good job overall, they did not implement all the features that are available for C/C++.

Two most notable features that are missing are:

Hopefully I get around to add these in the future, but any help is welcome.

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

1 Comment

As far as I can tell this is now working in doxygen as of version 1.9.7 (i.e. the ##< variant).

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.