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

Add annotations to the backend code #1201

Open
confluence opened this issue Sep 28, 2022 · 2 comments
Open

Add annotations to the backend code #1201

confluence opened this issue Sep 28, 2022 · 2 comments
Labels

Comments

@confluence
Copy link
Collaborator

confluence commented Sep 28, 2022

The backend code is currently not adequately documented. We should add annotations to all classes and functions which describe their interfaces and their intended function. If we use a format compatible with an automatic documentation generator like Doxygen or Sphinx, we will be able to use it to produce developer-facing documentation for the codebase automatically.

This is an epic; we should make smaller issues for adding annotations to more specific areas of the code and for setting up the automatic generation (which includes deciding on a tool and a way to host the docs).

@confluence confluence changed the title Add Doxygen annotations to the code and set up automatic generation of documentation Add annotations to the code and set up automatic generation of documentation Sep 28, 2022
@confluence
Copy link
Collaborator Author

Here's a possible direction (which would allow us to use Sphinx and Read The Docs, which we already use for other components and should also be able to use for the frontend).

@confluence
Copy link
Collaborator Author

Here is a similar project. We may be able to do something simpler; the preamble lists some alternatives.

@confluence confluence changed the title Add annotations to the code and set up automatic generation of documentation Add annotations to the backend code Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Icebox
Status: Icebox
Development

No branches or pull requests

1 participant