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

Virtual function documentation using Sphinx #600

Closed
Revbr opened this issue Nov 9, 2020 · 2 comments
Closed

Virtual function documentation using Sphinx #600

Revbr opened this issue Nov 9, 2020 · 2 comments
Assignees
Labels
code Source code enhancement Improvements, additions (also cosmetics)

Comments

@Revbr
Copy link

Revbr commented Nov 9, 2020

  1. I tried to document a C++ code using Sphinx, breathe and doxygen. The pdf doc generated in doxygen is coming correctly for virtual functions, but the pdf document generated using Sphinx(using doxygen xml) is just showing
    void functioname()
    instead of
    virtual void functionname().

  2. what is the doxygen directive for documenting overlaoded functions? I am getting error even after adding the arguments.

@vermeeren
Copy link
Collaborator

@Revbr

  1. Can you check if this problem also occurs with HTML output? Is it pure virtual or just virtual? If I check https://breathe.readthedocs.io/en/latest/doxygen.html the testMeToo doesn't show up properly with the virtual prefix too. Could be this needs to be added in Breathe or in Sphinx C/C++ domain. I do see some logic for adding virtual in breathe/renderer/sphinxrenderer.py, not entirely sure at this point.
    //! A pure virtual member.
    /*!
      \sa testMe()
      \param c1 the first argument.
      \param c2 the second argument.
    */
    virtual void testMeToo(char c1,char c2) = 0;

image

  1. Should be possible, but the syntax can be a bit finicky. cannot reference overloaded/class members #5 (comment) I remember seeing some other posts with examples in the issue tracker, but I cannot find them easily currently. Can you share function declaration?

jakobandersen added a commit to jakobandersen/breathe that referenced this issue Jan 29, 2021
@vermeeren vermeeren self-assigned this Feb 2, 2021
@vermeeren vermeeren added code Source code enhancement Improvements, additions (also cosmetics) labels Feb 2, 2021
@vermeeren
Copy link
Collaborator

The first point was just resolved thanks to #628. Since I never received a reply to the second point I will assume that is resolved too as it seems somewhat support-y.

Closing this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Source code enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

No branches or pull requests

2 participants