Hi,
I'm using Doxygen to document API of a mixed C and Python project. For
C Doxygen is excellent, the syntax is ok and output too. However, I'm
not satisfied with Python support.
For API in Python I use docstrings since it is standard. Obviously, I
don't want to write documentation twice, so I'm not using additional
#! comments for Doxygen. But for the docstrings I have only two
possibilities:
1. the verbatim documentation
2. exclamation mark at the docstring beginning ("""!)
Option 1 is not much useful (no links) and it is ugly. Option 2 uses
undocumented feature and has other negative consequences. Python tools
does not parse Doxygen syntax, so docstrings contains a lot of junk.
This is very bad comparing to the fact that reStructuredText is
usually well supported (rendered) by Python tools.
Now I'm considering if I should use Doxygen only for C API and Sphinx
(possibly with Breath) for Python API. My questions are:
Will be """! comment supported in the future by Doxygen (as it is now)?
Will be ReST syntax supported by Doxygen in near future (let's say
half a year)? What about Sphinx compatibility?
Will be general Python support improved? (Features such as properties
are not supported... but this is maybe for the another thread.)
Is there some independent ReST input filter for Doxygen somewhere? (So
I could just use Doxygen and that filter.)
Would doxypy help me? I got the impression that it is doing the same
as """! comment.
Thanks for your answers and thanks developers for great work.
Vaclav
I'm not sure if this is for users or develop mailing list but develop
seems to me more about bugs; but I can re-post some questions if
necessary.
Very related post to mailing list is "Python docstrings and
exclamation mark" (posted by me).
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_mar
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
