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.

Sign up for GitHub

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

Jump to bottom

Documentation needs to be updated to reflect the current state of code base #375

Open
abhiramm7 opened this issue May 13, 2022 · 2 comments
Open

Documentation needs to be updated to reflect the current state of code base #375

abhiramm7 opened this issue May 13, 2022 · 2 comments
Labels
type:tech-debt

Comments

@abhiramm7
Copy link
Collaborator

Documentation in its current state does not reflect all the functionality of OWA-SWMM.
@bemcdonnell
Copy link
Member

@abhiramm7 are you looking for a rebuild of the current gh-pages branch with the current docstrings with Doxygen?

@abhiramm7
Copy link
Collaborator Author

@bemcdonnell I was thinking more about updating Doxygen files to read the source code and examples on testing and building. Once that's done, we can generate HTML doc files that we can host on a webpage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:tech-debt
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bemcdonnell @abhiramm7