Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: solved some warnings in the RC-22.06 #251

Merged
merged 1 commit into from
May 17, 2022
Merged

Conversation

CW-75
Copy link
Collaborator

@CW-75 CW-75 commented May 17, 2022

Contribution description

This PR is solving all warnings presented by the generated doc, this will make changes in firmware modules and the wifi-subsystem elements, has solution to specify the path to the chamoc client files and generate its documentation, specify to ignore all CMakeList.txt files in subsystem to don't received warnings from them. solved some @params interpretation bad written.

Testing procedure

Generate the documentation file

make docs

Expected Output:

make[1]: Entering directory '/home/cyberwolf-75/Documents/m4a-firmware/doc/doxygen'
( cat m4a.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
/home/cyberwolf-75/Documents/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)
/home/cyberwolf-75/Documents/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)
make[1]: Leaving directory '/home/cyberwolf-75/Documents/m4a-firmware/doc/doxygen'

Note that all warnings presented was solved in your terminal.

Issues/PRs references

Fix #250

@CW-75 CW-75 merged commit 33a5296 into Mesh4all:main May 17, 2022
@CW-75 CW-75 deleted the feature/doc branch May 27, 2022 19:10
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Modify the m4a_doxyfile to could accept the chamoc documentation
2 participants