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

Add doxygen documentation to both include/kernel.h and include/legacy.h #2486

Closed
zephyrbot opened this issue Sep 27, 2016 · 3 comments
Closed
Labels
area: Kernel Enhancement Changes/Updates/Additions to existing features priority: high High impact/importance bug
Milestone

Comments

@zephyrbot
Copy link
Collaborator

zephyrbot commented Sep 27, 2016

Reported by Benjamin Walsh:

As a user of the kernel, I want to be able to reference both the new API and the legacy API in the documentation.

(Imported from Jira ZEP-981)

@zephyrbot
Copy link
Collaborator Author

by Benjamin Walsh:

include/legacy.h should be able to copy straight from the old implementations without a change.

Most of include/kernel.h should be able to pilfer from the legacy API as well, making cosmetic and name changes.

@zephyrbot
Copy link
Collaborator Author

by Mark Linkmeyer:

Per email from Ben Walsh on 10/18/16, this story is on track for 1.6.

@zephyrbot
Copy link
Collaborator Author

zephyrbot commented Nov 3, 2016

by Sharron LIU:

Verified doxygen comments are added to these header files.
Able to generate doxygen.
With a minor issue found logged as GH-2670.

@zephyrbot zephyrbot added priority: high High impact/importance bug area: Kernel Enhancement Changes/Updates/Additions to existing features labels Sep 23, 2017
@zephyrbot zephyrbot added this to the v1.6.0 milestone Sep 23, 2017
@zephyrbot zephyrbot mentioned this issue Sep 23, 2017
49 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Kernel Enhancement Changes/Updates/Additions to existing features priority: high High impact/importance bug
Projects
None yet
Development

No branches or pull requests

1 participant