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.

Sign up for GitHub

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

Jump to bottom

kernel.h doxygen show unexpected "asm" blocks #2670

Closed
zephyrbot opened this issue Nov 3, 2016 · 5 comments
Closed

kernel.h doxygen show unexpected "asm" blocks #2670

zephyrbot opened this issue Nov 3, 2016 · 5 comments
Labels
area: Build System area: Documentation area: Kernel bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Milestone
v1.6.0

Comments

@zephyrbot
Copy link
Collaborator

zephyrbot commented Nov 3, 2016 •
edited
Loading

Reported by Sharron LIU:

Create kernel API doc with doxygen, noticed "asm" blocks are shown unexpectedly. See screen snapshot.

# cd doc
# doxygen doxygen.config
# check generated files from "doc/html/d0/daa/kernel_8h.html"
# verify unexpected "asm" blocks shown
edit doxygen.config
INPUT = ../include/kernel.h ../include/legacy.h
GENERATE_HTML = YES

(Imported from Jira ZEP-1182)
@zephyrbot
Copy link
Collaborator Author

by Sharron LIU:

@zephyrbot
Copy link
Collaborator Author

by Benjamin Walsh:

Dmitriy Korovkin Can you take a quick look ? Seems the extensive memory pool inline asm macros break doxygen.

@zephyrbot
Copy link
Collaborator Author

by David Kinder:

Inaky Perez-Gonzalez Javier B Perez This HTML output from doxygen shouldn't even be on the website, right?

@zephyrbot
Copy link
Collaborator Author

by Sharron LIU:

Verify fixed. Thanks.

@zephyrbot
Copy link
Collaborator Author

by Mark Linkmeyer:

Fixing incorrect priority

@zephyrbot zephyrbot added priority: low Low impact/importance bug area: Kernel area: Documentation area: Build System bug The issue is a bug, or the PR is fixing a bug labels Sep 23, 2017
@zephyrbot zephyrbot added this to the v1.6.0 milestone Sep 23, 2017
This was referenced Sep 23, 2017
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: Build System area: Documentation area: Kernel bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Milestone
v1.6.0
Development

No branches or pull requests
1 participant
@zephyrbot