Documenting C/C++ Code
======================
NumPy uses Doxygen to parse specially-formatted C/C++ comment blocks. This generates
XML files, which are converted by Breathe into RST, which is used by Sphinx.
1. Writing the comment blocks
-----------------------------
Although there is still no commenting style set to follow, the Javadoc
is more preferable than the others due to the similarities with the current
existing non-indexed comment blocks.
The section title is seen as a enumerated list instead of a title.
I could try to send a PR upstream that remove the ., but I think it would be great if it could be fixed somehow.
In
The section title is seen as a enumerated list instead of a title.
I could try to send a PR upstream that remove the
.
, but I think it would be great if it could be fixed somehow.