Alter subclasses to inherit docs.

Before this they were being copy and pasted, this should properly inherit.

Signed-off-by: Taylor Lineman <git@actuallytaylor.com>

Author: ActuallyTaylor

include/core/dev/platform/f3xx/Timerf3xx.hpp

@@ -28,8 +28,9 @@ class TimerF3xx : public Timer {
      * Will initialize the timer device on the STM with the given period and the given IRQ Handler
      * that triggers with the given period.  Starts the timer
      *
-     * @param timerPeripheral[in] The timer peripheral to configure. Possible options for this board are
-     * TIM1, TIM2, TIM15, TIM16, TIM17.  It is up to the user to verify that resource conflicts do not occur.
+     * @param timerPeripheral[in] The timer peripheral to configure. It is up to the user to verify that resource conflicts do not occur.
+     * F334 Valid Options: TIM1, TIM2, TIM3, TIM15, TIM16, TIM17.
+     * F3O2 Valid Options: TIM1, TIM2, TIM15, TIM16, TIM17.
      * @param[in] timerPeripheral The timer to use
      * @param[in] clockPeriod The clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
      * at this frequency.
@@ -42,38 +43,19 @@ class TimerF3xx : public Timer {
                        const TimerConfiguration_t& configuration = defaultConfig,
                        uint32_t clockPrescaler                   = AUTO_PRESCALER);
 
-    /**
-     * Starts the given timer and registers the given interrupt pointer to trigger when the timer overflows
-     * @param[in] irqHandler The IRQ Handler function pointer.  Sets a new interrupt handler function
-     * @param[in] context The context to be sent to the irqHandler when it is called.
-     */
+    /** @inheritDoc */
     void startTimer(void (*irqHandler)(void* context, void* htim), void* context) override;
 
-    /**
-     * Starts the given timer using the IRQ Handler already assigned to that timer.
-     */
+    /** @inheritDoc */
     void startTimer() override;
 
-    /**
-     * Stops the current timer from running.  Does not complete its current counting sequence.
-     */
+    /** @inheritDoc */
     void stopTimer() override;
 
-    /**
-     * Resets the timer counter.
-     */
+    /** @inheritDoc */
     void reloadTimer() override;
 
-    /**
-     * Set the clock period for the timer. Will stop the timer, re-initialize the device with the updated period.
-     * You must call startTimer again to continue timer operation.
-     *
-     * @param[in] clockPeriod The clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
-     * at that frequency.
-     * @param [in] clockPrescaler The prescaler used by the clock. Divides the system clock frequency to get it within
-     * an acceptable range for clocking. If set to @ref AUTO_PRESCALER, the function implementation should calculate its
-     * own prescaler.
-     */
+    /** @inheritDoc */
     void setPeriod(uint32_t clockPeriod, uint32_t clockPrescaler = AUTO_PRESCALER) override;
 
 protected:
@@ -95,7 +77,7 @@ class TimerF3xx : public Timer {
     /**
      * Handles the initialization of the timer module.  Actually configures the device and enables it.
      *
-    * @param timerPeripheral[in] The timer peripheral to configure. It is up to the user to verify that resource conflicts do not occur.
+     * @param timerPeripheral[in] The timer peripheral to configure. It is up to the user to verify that resource conflicts do not occur.
      * F334 Valid Options: TIM1, TIM2, TIM3, TIM15, TIM16, TIM17.
      * F3O2 Valid Options: TIM1, TIM2, TIM15, TIM16, TIM17.
      * @param[in] clockPeriod the clock period in ticks (ms when using AUTO_PRESCALER).  An interrupt will be triggered

include/core/dev/platform/f4xx/Timerf4xx.hpp

@@ -44,37 +44,19 @@ class TimerF4xx final : public Timer {
                        const TimerConfiguration_t& configuration = defaultConfig,
                        uint32_t clockPrescaler                   = AUTO_PRESCALER);
 
-    /**
-     * Starts the given timer and registers the given interrupt pointer to trigger when the timer overflows
-     * @param[in] irqHandler The IRQ Handler function pointer.  Sets a new interrupt handler function
-     */
+    /** @inheritDoc */
     void startTimer(void (*irqHandler)(void* context, void* htim), void* context) override;
 
-    /**
-     * Starts the given timer using the IRQ Handler already assigned to that timer.
-     */
+    /** @inheritDoc */
     void startTimer() override;
 
-    /**
-     * Stops the current timer from running.  Does not complete its current counting sequence.
-     */
+    /** @inheritDoc */
     void stopTimer() override;
 
-    /**
-     * Resets the timer counter.
-     */
+    /** @inheritDoc */
     void reloadTimer() override;
 
-    /**
-     * Set the clock period for the timer.  Will stop the timer, re-initialize the device with the updated period.
-     * You must call startTimer again to continue timer operation.
-     *
-     * @param[in] clockPeriod the clock period in ticks (ms when using AUTO_PRESCALER).  An interrupt will be triggered
-     * at that frequency.
-     * @param [in] clockPrescaler the prescaler used by the clock. Divides the system clock frequency to get it within
-     * an acceptable range for clocking. If set to @ref AUTO_PRESCALER, the function implementation should calculate its
-     * own prescaler.
-     */
+    /** @inheritDoc */
     void setPeriod(uint32_t clockPeriod, uint32_t clockPrescaler = AUTO_PRESCALER) override;
 
 protected:

include/core/io/platform/f3xx/PWMf3xx.hpp

@@ -15,37 +15,22 @@ namespace core::io {
  */
 class PWMf3xx : public PWM, public dev::TimerF3xx {
 public:
-    /**
-     * Set up the given pin for PWM usage.
-     *
-     * @param pin[in] The pin to set up for PWM
-     */
+    /** @inheritDoc */
     explicit PWMf3xx(Pin pin);
 
-    /**
-     * Set the duty cycle for PWM
-     * @param[in] dutyCycle The duty cycle to set PWM at.
-     */
+    /** @inheritDoc */
     void setDutyCycle(uint32_t dutyCycle) override;
 
     /**
-     * Set the period for PWM.
-     * Note: This does not match the dev::TimerF3xx set period, since PWM does not accept a different period.
-     * This function will hide the definition from the superclass. So you can safely ignore the warning.
-     * @param[in] period The period for PWM.
+     * @inheritDoc PWM::setPeriod
+     * This function will hide the definition from the TimerF3xx. So you can safely ignore the warning.
      */
     void setPeriod(uint32_t period);
 
-    /**
-     * Get the current duty cycle.
-     * @return the duty cycle that the PWM instance is currently running at.
-     */
+    /** @inheritDoc */
     uint32_t getDutyCycle() override;
 
-    /**
-     * Get the current period.
-     * @return the period that the PWM instance is currently running at.
-     */
+    /** @inheritDoc */
     uint32_t getPeriod() override;
 
 private:

include/core/io/platform/f4xx/PWMf4xx.hpp

@@ -11,19 +11,19 @@ namespace core::io {
 
 class PWMf4xx : public PWM {
 public:
-    /**
-     * Setup the given pin for PWM usage.
-     *
-     * @param pin[in] The pin to setup for PWM
-     */
+    /** @inheritDoc */
     PWMf4xx(Pin pin);
 
+    /** @inheritDoc */
     void setDutyCycle(uint32_t dutyCycle) override;
 
+    /** @inheritDoc */
     void setPeriod(uint32_t period) override;
 
+    /** @inheritDoc */
     uint32_t getDutyCycle() override;
 
+    /** @inheritDoc */
     uint32_t getPeriod() override;
 
 private: