breathe

breathe copied to clipboard

Question: How to add free doxygen comments to output

2

I'm documenting a c-header using sphinx and breathe. Is there a way to make a `\mainpage ` section to be recognized by breathe? Simple example: ``` /* header.h*/ /** *...

KlasMvW

Specifying `EXTRACT_PRIVATE` to `NO` does not work (still gets rendered in `autodoxygenindex`)

1

Hey there! As in the title: in my `Doxyfile` I've specified `EXTRACT_PRIVATE` to `NO`. However, as I discovered in https://github.com/michaeljones/breathe/issues/826 I need to specify the arguments via specifying them in...

iquah1

Does breathe support Sphinx Internationalization?

1

I have generated my cpp doc with breathe + Sphinx as expected. Then I plan to translate thoes comments (cpp docs) to other languages. The steps are described in Sphinx's...

cheekyshibe

Breathe throws exception when Parameter and description are separated with non-alphanumeric character (see example below) Is this intended behavior due to non conforming doxygen comment for the parameter description or...

aborany

Support local namespace scope lookup

4

Hello, first of all thanks for this awesome extension to Sphinx. I would like to set a namespace like with the `.. cpp:namespace:: my_namespace` directive. Example.h ```{cpp} namespace my_namespace {...

arwedus

I just noticed that all admonitions for a page (at various places with in the page) are grouped and displayed at the bottom of the page when using `doxygenpage` directive....

2bndy5

warning: documentation for unknown define

1

I am having this pop up as an error with running doxygen/sphix/breath project: warning: documentation for unknown define The code snippets for reference: ok in the doxy.log source.h: warning: documentation...

combsie

Suppressing error/warning messages

4

After reading #242 I understand that interaction with Sphinx's C and C++ domains is fragile, and a proper fix for my issue may be some time coming. I have issues...

nega0

Add a mechanism for generating a list of members for a class, struct, etc.

14

The member list should by hyperlinked to the member documentation generated by the breathe directive. Either making this an option of the directive that generates the class/struct doc or a...

jo3w4rd

[Feature] Config Option to enable rst syntax by default

1

Dear breathe team, I'm (mis)using breathe to import Python docstrings as a replacement for autodoc, in a build environment where I don't have the python package dependencies available. I noticed...

arwedus