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

Making the Doxygen documentation more user-friendly #1080

Open
3 tasks
SimeonEhrig opened this issue Jul 14, 2020 · 0 comments
Open
3 tasks

Making the Doxygen documentation more user-friendly #1080

SimeonEhrig opened this issue Jul 14, 2020 · 0 comments

Comments

@SimeonEhrig
Copy link
Member

The Doxygen API is hard to read because they provide information about the users and the internal API. Making the Doxygen API easy to read without losing information is not possible. Therefore some points are planned to get a better access to the documentation.

  • add a highlighted link in the Doxygen doc to the Sphinx Doc, that makes it clear that you should read the Sphinx Doc first
  • explain concepts, namespaces and so in the Sphinx Doc to help you navigate the Doxygen document
  • add a clear and consistent description of the template parameter to Sphinx Doc, (e.g. TAcc is a type of the namespace alpaka::acc every time)
@sbastrakov sbastrakov added this to the Version 0.6.0 milestone Jul 14, 2020
@j-stephan j-stephan added this to To do in Release 0.8 via automation May 11, 2021
@j-stephan j-stephan removed this from To do in Release 0.8 Nov 10, 2021
@j-stephan j-stephan added this to To do in Release 0.9 via automation Nov 10, 2021
@j-stephan j-stephan removed this from the Version 0.9.0 (I/2022) milestone Mar 29, 2022
@j-stephan j-stephan removed this from To do in Release 0.9 Mar 29, 2022
@j-stephan j-stephan added this to To do in Release 1.0 via automation Mar 29, 2022
@j-stephan j-stephan removed this from To do in Release 1.0 Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants