Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doxygenfunction only works for the function has declaration? #1002

Open
jimmysitu opened this issue Dec 10, 2024 · 0 comments
Open

doxygenfunction only works for the function has declaration? #1002

jimmysitu opened this issue Dec 10, 2024 · 0 comments

Comments

@jimmysitu
Copy link

jimmysitu commented Dec 10, 2024

I am new to sphinx and breathe, and I try a simple project

I add the index.rst

.. doxygenfunction:: main()
   :project: MyCProject

.. doxygenfunction:: add(int, int)
   :project: MyCProject

.. doxygenfunction:: subtract(int, int)
   :project: MyCProject

and doxygen Doxygen; make -c docs html, I got some warning

/tmp/test-sphinx-breathe/docs/source/index.rst:24: WARNING: doxygenfunction: Cannot find function "main" in doxygen xml output for project "MyCProject" from directory: ../../doxygen/xml

And there is also the same warning in the html, and I found if I mask the declaration of subtract() in the header, there will be

/tmp/test-sphinx-breathe/docs/source/index.rst:30: WARNING: doxygenfunction: Cannot find function "subtract" in doxygen xml output for project "MyCProject" from directory: ../../doxygen/xml

I try doxygenfile::main.c, and everything is fine, anything I miss?

I upload my whole project to github

Sphinx version: 7.3.7, and breathe version: 4.35.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant