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
Readily available well-documented open-source documentation tools
Doxygen
Sphinx
Doxygen seems to more be widespread and have a better documetation. This could help us easily exhibit our public functions that should be used by the user and how they relate to the super class (which functions are overrided, which member variables are public, etc).
May also enable automatic UML style class-inheritance diagrams.
Work that would need to be done
Classes and their methods would need to have a commented header documenting the said-functions. A standard syntax would have to followed. Fortunately, this is already mostly done.
The text was updated successfully, but these errors were encountered:
Readily available well-documented open-source documentation tools
Doxygen seems to more be widespread and have a better documetation. This could help us easily exhibit our public functions that should be used by the user and how they relate to the super class (which functions are overrided, which member variables are public, etc).
May also enable automatic UML style class-inheritance diagrams.
Work that would need to be done
Classes and their methods would need to have a commented header documenting the said-functions. A standard syntax would have to followed. Fortunately, this is already mostly done.
The text was updated successfully, but these errors were encountered: