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

Doxygen based documentation #21

Open
projectgus opened this issue Aug 5, 2015 · 1 comment
Open

Doxygen based documentation #21

projectgus opened this issue Aug 5, 2015 · 1 comment

Comments

@projectgus
Copy link
Contributor

TODO:

  • Add doxygen markup to existing code comments.
  • Build doxygen for the project automatically to gh-pages.
  • Move current wiki content to doxygen documentation pages.
  • Add new content documenting OTA updates, clearer quickstart steps.
@projectgus
Copy link
Contributor Author

Small note that some of the documentation mentioned above (like OTA update details) has been added, but is currently in the github wiki:
https://github.com/SuperHouse/esp-open-rtos/wiki

Would still like eventually migrate it all to doxygen.

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

1 participant