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

Jump to bottom

Document missing keywords #1107

Open

mfalkvidd opened this issue Apr 8, 2018 · 1 comment

Labels

documentation enhancement

Contributor

mfalkvidd commented Apr 8, 2018 •

edited

The following keywords need Doxygen comments and inclusion in keywords.txt

MY_NRF5_RX_BUFFER_SIZE
MY_OTA_I2C_ADDR
MY_RFM69_DEFAULT_LISTEN_IDLE_US (already present in keywords.txt but no Doxygen)
MY_RFM69_DEFAULT_LISTEN_RX_US (already present in keywords.txt but no Doxygen)
MY_RF69_DIO5
MY_RFM95_ATC_TARGET_RSSI_DBM (already present in keywords.txt but no Doxygen)
MY_RFM95_ENABLE_ENCRYPTION
MY_W5100_SPI_EN (already present in keywords.txt but no Doxygen)

I don't know enough about how they are meant to be used to document them properly.

mfalkvidd added enhancement documentation labels

Contributor Author

mfalkvidd commented May 30, 2019

ARGH!!

There are now new missing keywords that lack documentation:
MY_AVR_TEMPERATURE_GAIN
MY_AVR_TEMPERATURE_OFFSET
MY_CRYPTO_SHA256_ASM
MY_ESP32_TEMPERATURE_GAIN
MY_ESP32_TEMPERATURE_OFFSET
MY_NRF5_RX_BUFFER_SIZE
MY_SAMD_TEMPERATURE_GAIN
MY_SAMD_TEMPERATURE_OFFSET
MY_STM32F1_TEMPERATURE_GAIN
MY_STM32F1_TEMPERATURE_OFFSET
MY_TRANSPORT_ENCRYPTION

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

3c3c4ba

Hopefully this will stop missing keywords from accumulating.

See also mysensors#1107

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

385cd4d

Hopefully this will stop missing keywords from accumulating.

See also mysensors#1107

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

2b3ed5d

Hopefully this will stop missing keywords from accumulating.

See also mysensors#1107

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

53af458

Hopefully this will stop missing keywords from
accumulating.

See also
mysensors#1107

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

47408c6

Hopefully this will stop missing keywords from
accumulating.

See also
mysensors#1107

mfalkvidd mentioned this issue

Add more checks for missing keywords #1297

Closed

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords

f9fdcc7

Hopefully this will stop missing keywords from
accumulating.

See also
mysensors#1107

mfalkvidd added a commit that referenced this issue


        Add more checks for missing keywords (#1293)

Hopefully this will stop missing keywords from
accumulating.

See also
#1107

mfalkvidd added a commit to mfalkvidd/MySensors that referenced this issue


        Add more checks for missing keywords (mysensors#1293)

36d87aa

Hopefully this will stop missing keywords from
accumulating.

See also
mysensors#1107

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

You can’t perform that action at this time.