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

Let the Butler report be clearer on where to add Doxygen comments #1521

Open
mfalkvidd opened this issue May 11, 2022 · 0 comments
Open

Let the Butler report be clearer on where to add Doxygen comments #1521

mfalkvidd opened this issue May 11, 2022 · 0 comments

Comments

@mfalkvidd
Copy link
Member

The Butler report currently looks like this:

If keywords don't have Doxygen comments, they will not be available at https://www.mysensors.org/apidocs/index.html Add Doxygen comments to make it easier for users to find and understand how to use the new keywords.
MY_GATEWAY_ESP8266_SECURE

IT would help contributors if the Butler report was more clear on where to add the Doxygen comments. Maybe something like this:

If keywords don't have Doxygen comments, they will not be available at https://www.mysensors.org/apidocs/index.html Add Doxygen comments to MyConfig.h to make it easier for users to find and understand how to use the new keywords. You can use existing keywords in MyConfig.h as inspiration / template.
MY_GATEWAY_ESP8266_SECURE

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

No branches or pull requests

1 participant