]> sigrok.org Git - libsigrok.git/commit - src/hardware/kingst-la2016/protocol.h
kingst-la2016: rephrase comments for style, readability, and text length
authorGerhard Sittig <redacted>
Thu, 20 Jan 2022 21:14:29 +0000 (22:14 +0100)
committerGerhard Sittig <redacted>
Sun, 6 Feb 2022 17:53:53 +0000 (18:53 +0100)
commit96dc954e1c17a34daafcccb0a6013873d7ec9ee4
treed47516e55c60381e92f4a7d60bdd90dba5de5286
parent91f738728dd0cff2f2a37626e103773663b9c88c
kingst-la2016: rephrase comments for style, readability, and text length

Rephrase comments in the Kingst LA2016 driver to better match the sigrok
project's style. Consistently start with capitals and end in punctuation.
Use all upper case for acronyms to improve readability.

Keep text lines to an acceptable length. Use consistent open and close
phrases for multi-line comments. Drop C++ style comments. Add braces
where comments and one-line code results in multi-line branches of flow
control statements.

This commit also consistently uses lower case for hex literals, and
unobfuscates a few other literals: Use 0xff everywhere for unknown USB
addresses, prefer 1800 * 1000 over 18e5 for a 1.8 seconds interval.
src/hardware/kingst-la2016/api.c
src/hardware/kingst-la2016/protocol.c
src/hardware/kingst-la2016/protocol.h