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

Fix Doxygen warnings #246

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Conversation

pjonsson
Copy link
Contributor

@pjonsson pjonsson commented Oct 30, 2023

The \c and \b commands accept a single word,
and there are no \section1 or \list commands
according to the Doxygen manual.

The \c and \b commands accept a single word,
and there are no \section1 or \list commands
according to the Doxygen manual.
@pjonsson pjonsson force-pushed the fix-doxygen-warnings branch from 09db969 to a4229fc Compare October 30, 2023 17:52
@pjonsson
Copy link
Contributor Author

Even with this patch, I still get a pile of warnings in doxygen.log that I'm not sure how to fix.

tinycbor/src/cbor.dox:74: warning: Documentation for undefined enum 'CborType' found.
tinycbor/src/cbor.dox:94: warning: Documentation for undefined enum 'CborKnownTags' found.
tinycbor/src/cborerrorstrings.c:32: warning: Documentation for undefined enum 'CborError' found.
tinycbor/src/cborpretty.c:136: warning: Documentation for undefined enum 'CborPrettyFlags' found.
tinycbor/src/cbortojson.c:669: warning: Documentation for undefined enum 'CborToJsonFlags' found.
tinycbor/src/cborvalidation.c:55: warning: Documentation for undefined enum 'CborValidationFlags' found.
tinycbor/src/cborparser_dup_string.c:87: warning: unable to resolve reference to 'CborErrorOutOfMemory' for \ref command
tinycbor/src/cborparser_dup_string.c:56: warning: unable to resolve reference to 'CborErrorOutOfMemory' for \ref command
tinycbor/src/cborparser.c:957: warning: unable to resolve reference to 'CborErrorDataTooLarge' for \ref command
tinycbor/src/cborparser.c:1273: warning: unable to resolve reference to 'CborErrorOutOfMemory' for \ref command
tinycbor/src/cborparser.c:1236: warning: unable to resolve reference to 'CborErrorOutOfMemory' for \ref command
tinycbor/src/cborparser.c:1357: warning: unable to resolve reference to 'CborErrorDataTooLarge' for \ref command
tinycbor/src/cborparser.c:1384: warning: unable to resolve reference to 'CborErrorDataTooLarge' for \ref command
tinycbor/src/cborparser.c:936: warning: unable to resolve reference to 'CborErrorDataTooLarge' for \ref command
tinycbor/src/cborparser.c:642: warning: unable to resolve reference to 'CborInvalidType' for \ref command
tinycbor/src/cborparser.c:1400: warning: unable to resolve reference to 'CborInvalidType' for \ref command
tinycbor/src/cborpretty.c:564: warning: unable to resolve reference to 'CborPrettyFlags' for \ref command

@thiagomacieira
Copy link
Member

\list is probably a qdoc'ism, but I thought I had fixed the issues long ago.

@thiagomacieira thiagomacieira merged commit 65a4147 into intel:main Oct 30, 2023
@pjonsson pjonsson deleted the fix-doxygen-warnings branch October 30, 2023 20:04
@pjonsson
Copy link
Contributor Author

I know the Doxygen in Ubuntu 18.04 has a lot fewer warnings than the Doxygen in Ubuntu 20.04 and 22.04. The CI seems to use Xenial (16.04), so I guess that is even more permissive.

If you're not already aware, my experience is that Doxygen breaks ENABLE_PREPROCESSING with PREDEFINED between patch releases. It worked for me with the Doxygen in Ubuntu 18.04, and is broken in Doxygen 1.9.1 which is what comes with Ubuntu 22.04. The issue is fixed in Doxygen 1.9.4, and 1.9.5 breaks the support again.

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.

2 participants