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

Improve APIDOC to properly generate sub-namespace docs #77

Closed
jfpoilpret opened this issue Jan 17, 2020 · 1 comment
Closed

Improve APIDOC to properly generate sub-namespace docs #77

jfpoilpret opened this issue Jan 17, 2020 · 1 comment
Assignees
Labels
documentation Improve or add documentation (API, tutorial, README...)
Milestone

Comments

@jfpoilpret
Copy link
Owner

Currentl, doxygen generation seems to "forget" some namespaces (or more precisely, namespaces inside namespaces) in some of the generated files:
image
In the example above, as we can see, we have the following issues:

  • the description of namespace devices is incorrect (that's the description for namespace devices::rtc)
  • the following devices sub-namespaces are missing: audio, magneto, rf...)

The problem might be due to doxygen comments directly set before declarations like:

namespace devices::rtc 
{
...
}
@jfpoilpret jfpoilpret self-assigned this Jan 17, 2020
@jfpoilpret jfpoilpret added the documentation Improve or add documentation (API, tutorial, README...) label Jan 17, 2020
@jfpoilpret jfpoilpret added this to the 1.6 milestone Jan 17, 2020
jfpoilpret pushed a commit that referenced this issue Jan 17, 2020
@jfpoilpret
Copy link
Owner Author

Solution is to add doxygen documentation to not-compound namespace:

namespace aaa {
    /**
     * Doc...
     */
    namespace bbb {
         ...
    }
}

@jfpoilpret jfpoilpret modified the milestones: 1.6, 1.5 Jan 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or add documentation (API, tutorial, README...)
Projects
None yet
Development

No branches or pull requests

1 participant