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

All function templates are marked as inline in docs #9

Closed
ninkibah opened this issue Mar 26, 2021 · 0 comments
Closed

All function templates are marked as inline in docs #9

ninkibah opened this issue Mar 26, 2021 · 0 comments
Assignees

Comments

@ninkibah
Copy link

Officially, AFAIK, function templates such as below are implicitly inline. Doxygen marks them as such, and breathe and sphinx pass that on.

template<typename T>
void foo(T) {}

I don't like seeing that inline specifier on every function in my library, and I tried to get rid of it.
Doxygen has a setting INLINE_INFO = ON/OFF. Unfortunately, it is always on for XML output, which is what is used by breathe.

My solution was to add a custom.js file which uses jquery to find the inline specifiers and delete them.

In conf.py add the following:

html_js_files = [
    'custom.js'
]

Add a custom.js to _static directory:

$(document).ready(function() {
  $("em.property > span.pre:contains('inline')").hide();
});

I've raised an issue in the Doxygen project:
doxygen/doxygen#8458

For now, I believe my solution will work, if you consider this a problem.

@ThePhD ThePhD closed this as completed in 4e1f956 Apr 22, 2021
@ThePhD ThePhD self-assigned this Jul 23, 2021
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

2 participants