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.

Sign up for GitHub

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

Jump to bottom

Total Vexation With Doxygen! #1195

Merged
merged 8 commits into from
Jun 15, 2020
Merged

Total Vexation With Doxygen! #1195

merged 8 commits into from
Jun 15, 2020

Conversation

crankyoldgit
Copy link
Owner

Comment all methods and doxify the comments in all protocols starting with: T, V, & W.

  • TCL
  • Teco
  • Toshiba
  • Trotec
  • Vestel
  • Whirlpool
  • Whynter

Minor clean ups along the way.

  • This should complete the Doxification of all the Protocol files (and pretty much every method/function/api in the library)

@crankyoldgit
Doxify TCL
0b08ccd 
- Fix typos in ir_Samsung.cpp
@crankyoldgit
Doxify Teco
85e5736 
- Add missing `.calibrate()` class method.
- Fix missing return comments in Samsung.
@crankyoldgit
Doxify Toshiba
d5cc711
@crankyoldgit
Doxify Trotec
1a7fc0d 
- Add missing on() & off() methods.
@crankyoldgit
Doxify Vestel
e7cd74c 
- Add repeats to `.send()` method.
@crankyoldgit
Doxify Whirlpool
0f8e91c 
- Fix missed doxygen comment in Vestel
- Fix typo in Trotec.
@crankyoldgit
Doxify Whynter
055213e 
- Add `const`s to `sendWhynter()`.
@crankyoldgit crankyoldgit self-assigned this Jun 15, 2020
NiKiZe
NiKiZe approved these changes Jun 15, 2020
View reviewed changes
src/ir_Tcl.h Show resolved Hide resolved
@NiKiZe
Copy link
Collaborator

NiKiZe commented Jun 15, 2020

Awesome work!
Do we have checks that tells us if anything is missing, if not could we make doxy do that?

@crankyoldgit
Copy link
Owner Author

Awesome work!

Thanks.

Do we have checks that tells us if anything is missing, if not could we make doxy do that?

Not yet. I think doxygen can do that. I'll experiment with it shortly.

@crankyoldgit crankyoldgit merged commit f720c19 into master Jun 15, 2020
@crankyoldgit crankyoldgit deleted the more_doxy branch June 15, 2020 06:21
@crankyoldgit
Copy link
Owner Author

Awesome work!

Thanks.

Do we have checks that tells us if anything is missing, if not could we make doxy do that?

Not yet. I think doxygen can do that. I'll experiment with it shortly.

So, I've experimented.
I can't seem to turn on "full" undocumented warnings without documenting every constant.
That's not going to happen for a while.

@NiKiZe
Copy link
Collaborator

NiKiZe commented Jun 15, 2020

There is no way to disable those warnings per file or similar?
Or run it once with all warnings and ignore specific files during that run?

@crankyoldgit
Copy link
Owner Author

Not that I've yet found. :-(
If I could disable warnings on variables I would.

You can see the mess yourself if you change EXTRACT_ALL to NO. :-/

crankyoldgit added a commit that referenced this pull request Jun 22, 2020
@crankyoldgit
v2.7.7 release (#1132)
5ebd0bc 
_v2.7.8 (20200622)_

**[BREAKING CHANGES]**
- Fix Manchester code handling; Increase Airwell to `34` bits. (#1200)

**[Bug Fixes]**
- Carrier40: Use correct gap value. (#1193)

**[Features]**
- CarrierAc64: Add detailed support. (#1133)
- Add experimental support for Hitachi A/C 344 bit protocol (#1139)
- Automatic & full library code/API documentation via Doxygen (#1150 #1154 #1155 #1156 #1158 #1165 #1167 #1169 #1180 #1184 #1189 #1191 #1194 #1195 #1197 #1198)
- Hitachi344: Add detailed support and change bit ordering. (#1147)
- Add Corona AC Protocol (#1152)
- Hitachi344: Add Swing(H) and improve Swing(V) (#1148)
- Update auto_analyse_raw_data.py with better code comment sections (#1164)
- Add support for Midea24 protocol. (#1171)
- Add basic Zepeal protocol support (#1178)

**[Misc]**
- scrape_supported_devices.py: avoid changes to SupportedProtocols.md (#1140)
- auto_analyze nice exit on empty rawdata input (#1141)
- Comments update + cleanup (#1143)
- Update D_STR_IRRECVDUMP_STARTUP text and comments. (#1144)
- Minor code cleanups (#1149)
- Update `README.md`'s to point to new API docs. (#1151)
- Update "Supports" sections (#1160)
- Add a `doxygen` check to CI/Travis. (#1161)
- scrape_supported_devices: warn about misplaced or legacy supports sections (#1159)
- Add Supports sections to some files (#1163 #1166)
- Fix compile error when `DEBUG` is enabled.
- Add no-output option and return code on error to scrape_supported_devices
- Travis: Add scrape_supported_devices error check
- Update auto_analyse_raw_data.py to have a default Supports: section
- Treat compiler warnings as errors. (#1174)
- Remove `calcLGChecksum()` and use new generic `sumNibbles()` (#1175)
- Suppress more potential compiler warnings. (#1179)
- Load balance travis tasks to reduce wall clock time. (#1183)
- Set PlatformIO's default baudrate to 115200 (#1188)
- Some fixes to Doshisha protocol handler
- Minor cleanups of Corona and Zepeal
- Enable Doxygen warning when the parameters for a function/method/procedure are wrong/missing. (#1196)
crankyoldgit added a commit that referenced this pull request Jun 22, 2020
@crankyoldgit
v2.7.8 release
a6ee4e3 
_v2.7.8 (20200622)_

**[BREAKING CHANGES]**
- Fix Manchester code handling; Increase Airwell to `34` bits. (#1200)

**[Bug Fixes]**
- Carrier40: Use correct gap value. (#1193)

**[Features]**
- CarrierAc64: Add detailed support. (#1133)
- Add experimental support for Hitachi A/C 344 bit protocol (#1139)
- Automatic & full library code/API documentation via Doxygen (#1150 #1154 #1155 #1156 #1158 #1165 #1167 #1169 #1180 #1184 #1189 #1191 #1194 #1195 #1197 #1198)
- Hitachi344: Add detailed support and change bit ordering. (#1147)
- Add Corona AC Protocol (#1152)
- Hitachi344: Add Swing(H) and improve Swing(V) (#1148)
- Update auto_analyse_raw_data.py with better code comment sections (#1164)
- Add support for Midea24 protocol. (#1171)
- Add basic Zepeal protocol support (#1178)

**[Misc]**
- scrape_supported_devices.py: avoid changes to SupportedProtocols.md (#1140)
- auto_analyze nice exit on empty rawdata input (#1141)
- Comments update + cleanup (#1143)
- Update D_STR_IRRECVDUMP_STARTUP text and comments. (#1144)
- Minor code cleanups (#1149)
- Update `README.md`'s to point to new API docs. (#1151)
- Update "Supports" sections (#1160)
- Add a `doxygen` check to CI/Travis. (#1161)
- scrape_supported_devices: warn about misplaced or legacy supports sections (#1159)
- Add Supports sections to some files (#1163 #1166)
- Fix compile error when `DEBUG` is enabled.
- Add no-output option and return code on error to scrape_supported_devices
- Travis: Add scrape_supported_devices error check
- Update auto_analyse_raw_data.py to have a default Supports: section
- Treat compiler warnings as errors. (#1174)
- Remove `calcLGChecksum()` and use new generic `sumNibbles()` (#1175)
- Suppress more potential compiler warnings. (#1179)
- Load balance travis tasks to reduce wall clock time. (#1183)
- Set PlatformIO's default baudrate to 115200 (#1188)
- Some fixes to Doshisha protocol handler
- Minor cleanups of Corona and Zepeal
- Enable Doxygen warning when the parameters for a function/method/procedure are wrong/missing. (#1196)
@crankyoldgit crankyoldgit mentioned this pull request Jun 22, 2020
Merged
crankyoldgit added a commit that referenced this pull request Jun 23, 2020
@crankyoldgit
v2.7.8 release (#1201)
c705abd 
## _v2.7.8 (20200622)_

**[BREAKING CHANGES]**
- Fix Manchester code handling; Increase Airwell to `34` bits. (#1200)

**[Bug Fixes]**
- Carrier40: Use correct gap value. (#1193)

**[Features]**
- CarrierAc64: Add detailed support. (#1133)
- Add experimental support for Hitachi A/C 344 bit protocol (#1139)
- Automatic & full library code/API documentation via Doxygen (#1150 #1154 #1155 #1156 #1158 #1165 #1167 #1169 #1180 #1184 #1189 #1191 #1194 #1195 #1197 #1198)
- Hitachi344: Add detailed support and change bit ordering. (#1147)
- Add Corona AC Protocol (#1152)
- Hitachi344: Add Swing(H) and improve Swing(V) (#1148)
- Update auto_analyse_raw_data.py with better code comment sections (#1164)
- Add support for Midea24 protocol. (#1171)
- Add basic Zepeal protocol support (#1178)

**[Misc]**
- scrape_supported_devices.py: avoid changes to SupportedProtocols.md (#1140)
- auto_analyze nice exit on empty rawdata input (#1141)
- Comments update + cleanup (#1143)
- Update D_STR_IRRECVDUMP_STARTUP text and comments. (#1144)
- Minor code cleanups (#1149)
- Update `README.md`'s to point to new API docs. (#1151)
- Update "Supports" sections (#1160)
- Add a `doxygen` check to CI/Travis. (#1161)
- scrape_supported_devices: warn about misplaced or legacy supports sections (#1159)
- Add Supports sections to some files (#1163 #1166)
- Fix compile error when `DEBUG` is enabled.
- Add no-output option and return code on error to scrape_supported_devices
- Travis: Add scrape_supported_devices error check
- Update auto_analyse_raw_data.py to have a default Supports: section
- Treat compiler warnings as errors. (#1174)
- Remove `calcLGChecksum()` and use new generic `sumNibbles()` (#1175)
- Suppress more potential compiler warnings. (#1179)
- Load balance travis tasks to reduce wall clock time. (#1183)
- Set PlatformIO's default baudrate to 115200 (#1188)
- Some fixes to Doshisha protocol handler
- Minor cleanups of Corona and Zepeal
- Enable Doxygen warning when the parameters for a function/method/procedure are wrong/missing. (#1196)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NiKiZe NiKiZe NiKiZe approved these changes

@sillyfrog sillyfrog Awaiting requested review from sillyfrog

Assignees

@crankyoldgit crankyoldgit

Labels
Documentation enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@crankyoldgit @NiKiZe