Skip to content

Add Doxygen API docs #314

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

Merged
merged 41 commits into from
Sep 2, 2021
Merged

Add Doxygen API docs #314

merged 41 commits into from
Sep 2, 2021

Conversation

jmklix
Copy link
Member

@jmklix jmklix commented Aug 26, 2021

Issue #, if available:
#169

Description of changes:
Add api docs generated by doxygen

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@github-pages github-pages bot temporarily deployed to github-pages August 26, 2021 18:07 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 26, 2021 18:18 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 26, 2021 18:33 Inactive
@@ -76,6 +76,7 @@ The best way to interact with our team is through GitHub. You can [open an issue
Please make sure to check out our resources too before opening an issue:

* Our [FAQ](FAQ.md)
* [API Docs](https://aws.github.io/aws-iot-device-sdk-cpp-v2/)
* Our [Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be great to get comments on the generated service code, like we have in python. But that requires touching the code generators, which is not trivial. But we should do it some day

@github-pages github-pages bot temporarily deployed to github-pages August 26, 2021 18:42 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 26, 2021 18:42 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 27, 2021 21:10 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 30, 2021 21:50 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 30, 2021 21:57 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 30, 2021 22:04 Inactive
@TingDaoK
Copy link
Contributor

It looks good! Thanks for fixing it!
Two things I think we can do better:

  • Maybe add a script to generate it? We can add it to our release pipeline to update the docs automatically, like what we did for aws-crt-cpp
  • Maybe we should link the crt stuff back to the aws-crt-cpp docs, instead of generating it again? Like python, we have the sdk doc pointing back to aws-crt-python doc, which is nicer. But, the aws-crt-cpp doc seems broken now, and if it's too much work, we can put it into the backlog.

@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 18:44 Inactive
@jmklix jmklix linked an issue Sep 1, 2021 that may be closed by this pull request
@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 19:27 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 19:33 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 22:23 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 22:31 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 1, 2021 23:56 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 2, 2021 17:58 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 2, 2021 18:03 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 2, 2021 18:30 Inactive
@github-pages github-pages bot temporarily deployed to github-pages September 2, 2021 22:35 Inactive
@jmklix jmklix merged commit 73779f8 into main Sep 2, 2021
@jmklix jmklix deleted the doxygen branch September 2, 2021 22:48
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.

Missing documentation for the SDK
3 participants