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

docs: running doxygen generates some warnings #377

Open
luisan00 opened this issue Mar 20, 2023 · 0 comments
Open

docs: running doxygen generates some warnings #377

luisan00 opened this issue Mar 20, 2023 · 0 comments
Labels
Area: doc Type: bug Something isn't working Type: question Further information is requested
Milestone

Comments

@luisan00
Copy link
Contributor

Description

Run

$ make docs

Then the script executes

cd doc/doxygen && make
make[1]: se entra en el directorio 'm4a-firmware/doc/doxygen'
( cat m4a.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -

Results

m4a-firmware/dist/tools/uncrustify/whitelist.txt:4: warning: Reached end of file while still inside a (nested) comment. Nesting level 3 (probable line reference: 3, 2, 1)
m4a-firmware/dist/tools/whitespacecheck/ignore_list.txt:3: warning: Reached end of file while still inside a (nested) comment. Nesting level 2 (probable line reference: 2, 1)
m4a-firmware/firmware/sys/storage/include/storage_register.h:39: warning: Compound mtd_register_t is not documented.
m4a-firmware/firmware/default_params.h:68: warning: Compound settings_net_t is not documented.
m4a-firmware/firmware/default_params.h:94: warning: Member IF_KEY (macro definition) of file default_params.h is not documented.
m4a-firmware/firmware/network/net_tools/include/net_tools.h:47: warning: Member BITS_IN_A_BYTE (macro definition) of group net_tools is not documented.
m4a-firmware/firmware/network/net_tools/include/net_tools.h:48: warning: Member PREFIX_LSHIFTTED_BITS (macro definition) of group net_tools is not documented.
m4a-firmware/firmware/sys/uniqueid/include/uniqueid.h:37: warning: Member LAST_OCTECTS (macro definition) of file uniqueid.h is not documented.
m4a-firmware/firmware/sys/uniqueid/include/uniqueid.h:38: warning: Member OCTETS_BYTE_SIZE (macro definition) of file uniqueid.h is not documented.
m4a-firmware/firmware/sys/uniqueid/include/uniqueid.h:51: warning: Member uniqueid_mode_t (enumeration) of file uniqueid.h is not documented.
m4a-firmware/firmware/network/net_tools/include/net_tools.h:47: warning: Member BITS_IN_A_BYTE (macro definition) of group net_tools is not documented.
m4a-firmware/firmware/network/net_tools/include/net_tools.h:48: warning: Member PREFIX_LSHIFTTED_BITS (macro definition) of group net_tools is not documented.

make[1]: se sale del directorio 'm4a-firmware/doc/doxygen'

Then the following issues should be solved

1. Warning in txt file; whitelist.txt

dist/tools/uncrustify/whitelist.txt:4: warning: Reached end of file while still inside a (nested) comment. Nesting level 3 (probable line reference: 3, 2, 1)

2. Warning in txt file; ignore_list.txt

dist/tools/whitespacecheck/ignore_list.txt:3: warning: Reached end of file while still inside a (nested) comment. Nesting level 2 (probable line reference: 2, 1)

3. Warning in header file; storage_register.h

firmware/sys/storage/include/storage_register.h:39: warning: Compound mtd_register_t is not documented.

4. Warning in header file; default_params.h

firmware/default_params.h:68: warning: Compound settings_net_t is not documented.

5. Warning in header file; default_params.h

firmware/default_params.h:94: warning: Member IF_KEY (macro definition) of file default_params.h is not documented.

6. Warning in header file; net_tools.h

firmware/network/net_tools/include/net_tools.h:47: warning: Member BITS_IN_A_BYTE (macro definition) of group net_tools is not documented.

7. Warning in header file; net_tools.h

firmware/network/net_tools/include/net_tools.h:48: warning: Member PREFIX_LSHIFTTED_BITS (macro definition) of group net_tools is not documented.

8. Warning in header file; uniqueid.h

firmware/sys/uniqueid/include/uniqueid.h:37: warning: Member LAST_OCTECTS (macro definition) of file uniqueid.h is not documented.

9. Warning in header file; uniqueid.h

firmware/sys/uniqueid/include/uniqueid.h:38: warning: Member OCTETS_BYTE_SIZE (macro definition) of file uniqueid.h is not documented.

10. Warning in file; uniqueid.h

firmware/sys/uniqueid/include/uniqueid.h:51: warning: Member uniqueid_mode_t (enumeration) of file uniqueid.h is not documented.

11. Warning in header file;

firmware/network/net_tools/include/net_tools.h:47: warning: Member BITS_IN_A_BYTE (macro definition) of group net_tools is not documented.

12. Warning in header file; net_tools.h

firmware/network/net_tools/include/net_tools.h:48: warning: Member PREFIX_LSHIFTTED_BITS (macro definition) of group net_tools is not documented.
@luisan00 luisan00 added Type: bug Something isn't working Type: question Further information is requested Area: doc labels Mar 20, 2023
@luisan00 luisan00 added this to the 0.23.06 milestone Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Type: bug Something isn't working Type: question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant