Skip to content

The function's help textes are wrong #1430

Closed
@GURKE

Description

@GURKE

The manual of many functions of the HardwareTimer.cpp are wrong. (https://github.com/stm32duino/Arduino_Core_STM32/blob/633606a4664b81a81042db3496d88629c39aaf39/cores/arduino/HardwareTimer.cpp)

The manual of the functions:
void HardwareTimer::setPWM(uint32_t channel, PinName pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback, callback_function_t CompareCallback) void HardwareTimer::setPWM(uint32_t channel, uint32_t pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback, callback_function_t CompareCallback)
are listing the parameter format which does not exist! Instead the paramters callback_function_t PeriodCallback and callback_function_t CompareCallback exist but don't have any help text!?

Also this function:
uint32_t HardwareTimer::getCaptureCompare(uint32_t channel, TimerCompareFormat_t format)
It does have a return value but the info text says that it does not have any return values.

Maybe there are some more wrong helping textes. These are the first one I found.

Metadata

Metadata

Assignees

Labels

documentation 📚Improvements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions