Skip to content

Commit

Permalink
[Docs] resolve some Doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
tttapa committed Nov 3, 2024
1 parent 2e76525 commit fb27191
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/AH/Hardware/ExtendedInputOutput/ExtendedIOElement.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ BEGIN_AH_NAMESPACE
* ExtendedIOElement serves as a base class for all these expanders.
*
* The pins of each extended IO element are mapped to a pin number greater than
* the greatest Arduino pin number, represented by the @ref pin_t type.
* the greatest Arduino pin number, represented by the @ref ExtIO::pin_t type.
* You can supply this pin number to the IO functions in the @ref ExtIO
* namespace.
* If the pin number corresponds to an actual Arduino pin, the default Arduino
Expand Down Expand Up @@ -52,8 +52,8 @@ BEGIN_AH_NAMESPACE
* microcontrollers.
* Another reason to do it this way, is that this approach is still fast enough
* to make sure it is not noticeable to human users.
* If you need faster extended GPIO access, you can use the @ref CachedExtIOPin
* class.
* If you need faster extended GPIO access, you can use the
* @ref ExtIO::CachedExtIOPin class.
*/
class ExtendedIOElement : public UpdatableCRTP<ExtendedIOElement> {
protected:
Expand Down
2 changes: 1 addition & 1 deletion src/AH/Hardware/FilteredAnalog.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class GenericFilteredAnalog {
filter(increaseBitDepth<ADC_BITS + IncRes, Precision, AnalogType,
AnalogType>(initial)) {}

/// @copydoc GenericFilteredAnalog(pin_t,MappingFunction,AnalogType)
/// @copydoc GenericFilteredAnalog::GenericFilteredAnalog(pin_t,MappingFunction,AnalogType)
GenericFilteredAnalog(ArduinoPin_t analogPin, MappingFunction mapFn,
AnalogType initial = 0)
: GenericFilteredAnalog(pin_t(analogPin),
Expand Down
2 changes: 1 addition & 1 deletion src/AH/Hardware/Hardware-Types.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ using analog_t = uint16_t;
/// Integer type used internally to store the index of (extended) GPIO pins.
/// This type is also used to represent _offsets_ of pin
/// numbers (e.g. the index of a pin within an extended IO element).
/// In contrast, @ref pin_t represents an _absolute_ pin number.
/// In contrast, @ref ExtIO::pin_t represents an _absolute_ pin number.
using pin_int_t = uint_fast16_t;
constexpr pin_int_t NO_PIN_INT =
(std::numeric_limits<pin_int_t>::max() >> 1) + 1;
Expand Down

0 comments on commit fb27191

Please sign in to comment.