Doxypy - Member (variable) Of Namespace Is Not Documented
I get the error message warning: Member constant1 (variable) of namespace is not documented. for my doxygen (doxypy) documentation. I have documented the file and
Solution 1:
@albert was right. It works when putting a ## in front of the variables. I didn't find a solution using the """ syntax.
"""\file
\brief <this is what the file contains>
\author <author>
"""import numpy as np
## Doxygen documentation for constant1
constant1 = 24## Doxygen documentation for constant2
constant2 = 48defsomeFunction():
""" Doxygen documentation of someFunction() """
<body>
Solution 2:
If you need (because of any reason) to have more documentation for those members, you can also split the text into several lines. It will be treated as """ block.
## Doxygen documentation for constant1. The way which you already found.constant1 = 24## Doxygen documentation for constant2.# If you need to write a lot about constant2, you can split the text into# several lines in this way.constant2 = 48
Post a Comment for "Doxypy - Member (variable) Of Namespace Is Not Documented"