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

new documentation build warning #29896

Closed
pabigot opened this issue Nov 9, 2020 · 4 comments · Fixed by #29922
Closed

new documentation build warning #29896

pabigot opened this issue Nov 9, 2020 · 4 comments · Fixed by #29922
Assignees
@utzig
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug

Comments

@pabigot
Copy link
Collaborator

pabigot commented Nov 9, 2020

From #28779 which included a closing @} in the header without any opening one. Probably some of the macros in this are supposed to be in user documentation

 ---- New errors/warnings not tracked as .known-issues/, please fix them ----

/mnt/nordic/zp/zephyr/include/sys/util_macro.h:577: warning: unbalanced grouping commands
@pabigot pabigot added the bug The issue is a bug, or the PR is fixing a bug label Nov 9, 2020
@utzig
Copy link
Member

utzig commented Nov 9, 2020

@pabigot What is your Doxygen version?

@pabigot
Copy link
Collaborator Author

pabigot commented Nov 9, 2020

What is your Doxygen version?

Locally built, doxygen-Release_1_8_19-5-g8e87f6bb4 which is a little past 1.8.19.

@pabigot
Copy link
Collaborator Author

pabigot commented Nov 9, 2020

Regardless, the file needs to be fixed to have balanced group commands.

@utzig
Copy link
Member

utzig commented Nov 9, 2020

Regardless, the file needs to be fixed to have balanced group commands.

I have not considered not fixing the file. I just found it weird that 1.8.13 ignores the problem. I will check if we can just move on to something a bit newer...

utzig added a commit to utzig/zephyr that referenced this issue Nov 10, 2020
@utzig
doc: fix reference/util after sys/util.h split
37c45bf 
Add back Doxygen documentation that previously existed in sys/util.h
and was moved to sys/util_macro.h.

Also fixes zephyrproject-rtos#29896

Signed-off-by: Fabio Utzig <[email protected]>
@utzig utzig mentioned this issue Nov 10, 2020
Merged
carlescufi pushed a commit that referenced this issue Nov 10, 2020
@utzig @carlescufi
doc: fix reference/util after sys/util.h split
448db80 
Add back Doxygen documentation that previously existed in sys/util.h
and was moved to sys/util_macro.h.

Also fixes #29896

Signed-off-by: Fabio Utzig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@utzig utzig

Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: fix reference/util after sys/util.h split utzig/zephyr
3 participants
@utzig @pabigot @carlescufi