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

First Doxygen output #116

Merged
merged 7 commits into from
Nov 26, 2015
Merged

First Doxygen output #116

merged 7 commits into from
Nov 26, 2015

Conversation

metc
Copy link
Contributor

@metc metc commented Nov 25, 2015

@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...

@ciarmcom
Copy link
Member

Automatic CI verification build not done, please verify manually.

@metc
Copy link
Contributor Author

metc commented Nov 25, 2015

What is wrong with Mr. mbed Jenkins CI @ciarmcom ?

@rgrover rgrover merged commit a0ebd09 into ARMmbed:develop Nov 26, 2015
@rgrover
Copy link
Contributor

rgrover commented Nov 26, 2015

thanks so much for submitting these changes. I've merged a conservative version of your proposal into develop. Doxygen related files are still under flux. We'll soon merge develop into master and publish doxygen docs. (ref @iriark01)

@metc
Copy link
Contributor Author

metc commented Nov 26, 2015

Thanks @rgrover for merging this PR. According to fa755f1, you are not interested in the separated folder, Makefile or a Travis CI setup ?
Should the Doxygen intro page be merge with the README file ?
Can you also explain me what is wrong with the Automatic CI ?

@rgrover
Copy link
Contributor

rgrover commented Nov 26, 2015

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.

@metc
Copy link
Contributor Author

metc commented Nov 26, 2015

Great, makes sense. Please let me know if I can help.

@rgrover
Copy link
Contributor

rgrover commented Nov 26, 2015

You can help by continuing to submit improvements to the documentation.

@rgrover
Copy link
Contributor

rgrover commented Nov 26, 2015

@metc metc deleted the doxygen branch November 26, 2015 20:31
@metc
Copy link
Contributor Author

metc commented Nov 26, 2015

Thanks @rgrover Need some polishing but this is a good start 🎶 See #120
Do you have to publish the Doxygen output manually or is the process automated ?

@rgrover
Copy link
Contributor

rgrover commented Nov 27, 2015

@metc: presently, it is a manual process triggered from the 'master' branch. So it would take some time before changes make it to the user-visible documentation; but we can trigger a rebuild if there are significant improvements to docs. @iriark01

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants