You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
The text was updated successfully, but these errors were encountered:
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
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).
Here is a similar project. We may be able to do something simpler; the preamble lists some alternatives.
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
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).
The text was updated successfully, but these errors were encountered: