-
Notifications
You must be signed in to change notification settings - Fork 839
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
update auto_analyse script to use new param documentation #1126
Conversation
i.e. use "/// @param[in,out] paramname description" Also add documentation comments to more functions
I might have bodged something in the style, and not actually tested any of this against doxygen, so feel free to bash it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Geez. You're on the ball and a head of the curve!
Heck, I haven't even gotten Doxygen to anywhere near how I'd like it and you're already adding it to the "rough" auto-generation tools. Top marks!
Looks Great To Me!
@NiKiZe Go on, you've earned it (again), you can do the squash & merge. ;-) |
_v2.7.7 (20200519)_ **[BREAKING CHANGES]** - Fix Symphony protocol. (#1107, #1105) * Now 12 bits and bits are inverted. All previous codes will no longer work. - IRMQTTServer: Better handle power & mode operations for Home Assistant. (#1099, #1092) * When `MQTT_CLIMATE_HA_MODE` is enabled (default) this will break previous operation mode resumption when power is changed. **[Bug Fixes]** - Set correct return type for `.calibrate()` (#1095, #1093) **[Features]** - Add basic support for Carrier 40 & 64 bit protocols. (#1125, @1112, #1127) - Gree: Enable native support for Fahrenheit (#1124, #1121) - Gree: Add option to control display temp source. (#1120, #1118) - Add support for Multibrackets protocol. (#1106, #1103) - Add RawToPronto.py tool & improve `sendPronto()` precision (#1104, #1103) - Add support for `Doshisha` LED light protocol (#1115) - Introduce IRrecvDumpV3 with basic OTA update support (#1111) - Add detailed support for Delonghi A/C (#1098, #1096) - Improved support for SharpAc. (#1094, #1091) - Update auto_analyse to use new decode call structure. (#1102, #1097) - Added Blynk app example (#1090) **[Misc]** - update auto_analyse script to use new param documentation (#1126) - Improve `raw_to_pronto_code.py` (#1122, #1103) - Use pattern rules in Makefiles to reduce specific rule (#1110) - Update list of supported Daikin models. (#1101)
_v2.7.7 (20200519)_ **[BREAKING CHANGES]** - Fix Symphony protocol. (#1107, #1105) * Now 12 bits and bits are inverted. All previous codes will no longer work. - IRMQTTServer: Better handle power & mode operations for Home Assistant. (#1099, #1092) * When `MQTT_CLIMATE_HA_MODE` is enabled (default) this will break previous operation mode resumption when power is changed. **[Bug Fixes]** - Set correct return type for `.calibrate()` (#1095, #1093) **[Features]** - Add basic support for Carrier 40 & 64 bit protocols. (#1125, #1112, #1127) - Gree: Enable native support for Fahrenheit (#1124, #1121) - Gree: Add option to control display temp source. (#1120, #1118) - Add support for Multibrackets protocol. (#1106, #1103) - Add RawToPronto.py tool & improve `sendPronto()` precision (#1104, #1103) - Add support for `Doshisha` LED light protocol (#1115) - Introduce IRrecvDumpV3 with basic OTA update support (#1111) - Add detailed support for Delonghi A/C (#1098, #1096) - Improved support for SharpAc. (#1094, #1091) - Update auto_analyse to use new decode call structure. (#1102, #1097) - Added Blynk app example (#1090) **[Misc]** - update auto_analyse script to use new param documentation (#1126) - Improve `raw_to_pronto_code.py` (#1122, #1103) - Use pattern rules in Makefiles to reduce specific rule (#1110) - Update list of supported Daikin models. (#1101)
_v2.7.7 (20200519)_ **[BREAKING CHANGES]** - Fix Symphony protocol. (#1107, #1105) * Now 12 bits and bits are inverted. All previous codes will no longer work. - IRMQTTServer: Better handle power & mode operations for Home Assistant. (#1099, #1092) * When `MQTT_CLIMATE_HA_MODE` is enabled (default) this will break previous operation mode resumption when power is changed. **[Bug Fixes]** - Set correct return type for `.calibrate()` (#1095, #1093) **[Features]** - Add basic support for Carrier 40 & 64 bit protocols. (#1125, #1112, #1127) - Gree: Enable native support for Fahrenheit (#1124, #1121) - Gree: Add option to control display temp source. (#1120, #1118) - Add support for Multibrackets protocol. (#1106, #1103) - Add RawToPronto.py tool & improve `sendPronto()` precision (#1104, #1103) - Add support for `Doshisha` LED light protocol (#1115) - Introduce IRrecvDumpV3 with basic OTA update support (#1111) - Add detailed support for Delonghi A/C (#1098, #1096) - Improved support for SharpAc. (#1094, #1091) - Update auto_analyse to use new decode call structure. (#1102, #1097) - Added Blynk app example (#1090) **[Misc]** - update auto_analyse script to use new param documentation (#1126) - Improve `raw_to_pronto_code.py` (#1122, #1103) - Use pattern rules in Makefiles to reduce specific rule (#1110) - Update list of supported Daikin models. (#1101)
FYI, the changes mentioned above have now been included in the latest release (v2.7.7) of the library. |
To match new param documentation matching doxygen
Introduced from Library API documentation #1100
Also add documentation comments to more functions