-
Notifications
You must be signed in to change notification settings - Fork 75
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
First Doxygen output #116
First Doxygen output #116
Conversation
Sync with develop branch
Mardkown links syntax was inverted :)
Move doc files to the doxygen folder.
Automatic CI verification build not done, please verify manually. |
What is wrong with Mr. mbed Jenkins CI @ciarmcom ? |
thanks so much for submitting these changes. I've merged a conservative version of your proposal into |
Chris (ref @metc), we're aiming to host documentation using docs.mbed.com. Integration with this system is currently under progress. We'll be releasing something shortly. |
Great, makes sense. Please let me know if I can help. |
You can help by continuing to submit improvements to the documentation. |
@rgrover added Doxygen support in commits 04d10f6 and f72edf4.
This is great! IMO, it is a must have for an API 😏
I refactored all Doxygen stuff to a specific folder (to keep some consistency, I did the same as mbedtls) . I added a Makefile to generate the doc automatically and fix some typos (especially wrong Markdown syntax).
This is the very first Doxygen output and the documentation is not well formatted yet. A lot of polishing is needed... I am not native English speaker, so I cannot correct the doc or add Doxygen pages.
What we can do is publishing automatically the Doxygen documentation (for release versions) to
gh-page
so the doc is available online instantaneously (here is an example - https://tls.mbed.org/api/). I can do this job, please let me know if you are interested...