Is there a way to combine doxygen comments, like this one
## Documentation for a function.
# @var a - variable
# More details.
def func( a ):
pass
with the doc strings, like this one
def func( a ):
""" Documentation for a function.
More details.
"""
pass
?
Obviously, one would like to write the documentaion only once.
Best regards,
Gabriel.
--
/-----------------------------------------------------------------------\
| Any intelligent fool can make things bigger, more complex, |
| or more violent. It takes a touch of genius - and a lot of courage - |
| to move in the opposite direction. (Einstein) |
\-----------------------------------------------------------------------/ 6 3302
Gabriel Zachmann wrote: Is there a way to combine doxygen comments, like this one
## Documentation for a function. # @var a - variable # More details.
def func( a ): pass
with the doc strings, like this one
def func( a ): """ Documentation for a function. More details. """ pass
? Obviously, one would like to write the documentaion only once.
Best regards, Gabriel.
Gabriel,
Although it is not documented yet, doxygen understands the following:
def func( a ):
"""! @brief Documentation for a function.
@var a This is a variable
@return Nothing
More details.
"""
I found this information in a mailing list (of which I don't know it's
name anymore)
Good luck, Henk
Gabriel Zachmann wrote: Is there a way to combine doxygen comments, like this one
## Documentation for a function. # @var a - variable # More details.
def func( a ): pass
with the doc strings, like this one
def func( a ): """ Documentation for a function. More details. """ pass
? Obviously, one would like to write the documentaion only once.
Best regards, Gabriel.
Gabriel,
Although it is not documented yet, doxygen understands the following:
def func( a ):
"""! @brief Documentation for a function.
@var a This is a variable
@return Nothing
More details.
"""
I found this information in a mailing list (of which I don't know it's
name anymore)
Good luck, Henk
Gabriel Zachmann wrote: Is there a way to combine doxygen comments, like this one
If you are not tied to doxygen, you might consider epydoc - it uses the
docstrings, and restructured text which is friendly to the eye.
Regards,
Diez
Gabriel Zachmann wrote: Is there a way to combine doxygen comments, like this one
If you are not tied to doxygen, you might consider epydoc - it uses the
docstrings, and restructured text which is friendly to the eye.
Regards,
Diez This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics
by: Erwin Burgstaller |
last post by:
When I have several header files with "namespace x {}" in each, the
resulting doxygen documentation lists the Namespace exactly as often as
there are header files with that namespace in. Thats only...
|
by: lars |
last post by:
Hi,
we use DoxyGen together with the DOT tool of AT&T to document our
sources.
Here now is my problem (trying to explain as well as I can):
I intend to generate call graphs with the help of...
|
by: Konrad Mühler |
last post by:
Hallo,
kennt jemand ein Forum oder eine Newsgroup in der Fragen zu Doxygen
geklärt werden können?
Habt Dank
Konrad
|
by: David Dvali |
last post by:
Hello.
What is Doxygen tagging and how it can be used for source code documenting?
|
by: Olaf Wasmuth |
last post by:
Good morning,
I am using doxygen to create a reference manual for C source code. Do
you know of a way to similarly create a texinfo reference manual (which
I would like to use in emacs...
|
by: musicloverlch |
last post by:
I have a table with multiple records in it. I am being forced to
combine multiple records into one record in order to be uploaded to a
website, and I only get one record per client. How can I...
|
by: Ivan Vecerina |
last post by:
What tagged comment syntax do you use to document C++/CLI code ?
As far as I know, doxygen does not currently support C++/CLI.
Are there other/similar tools?
Does Microsoft provide an equivalent...
|
by: Jan Danielsson |
last post by:
Hello all,
I guess I should really be asking in some doxygen mailing list, but
since I believe that I found doxygen through this group, I assume that
there are some people here who can answer.
...
|
by: Peter Olcott |
last post by:
http://www-scf.usc.edu/~peterchd/doxygen/
The above is an example of what the output should look like.
I ran Doxygen on a simple program that I wrote to test
Doxygen, and all of the Call Graph...
|
by: PeteOlcott |
last post by:
So far I can only get Doxygen to generate callergraphs for ALL
functions or for NO functions, Doxygen seems to be ignoring the
\callergraph command. Does anyone know how to limit Doxygen to...
|
by: Hystou |
last post by:
There are some requirements for setting up RAID:
1. The motherboard and BIOS support RAID configuration.
2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
|
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers,...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
|
by: TSSRALBI |
last post by:
Hello
I'm a network technician in training and I need your help.
I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs.
The...
|
by: adsilva |
last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
| |