Update doc

include/sta/stm32/gpio_pin.hpp

@@ -8,7 +8,7 @@
 /**
  * @defgroup stm32GPIO GPIO
  * @ingroup stm32
- * @brief STM GPIO module.
+ * @brief STM32 GPIO module.
  */
 
 #ifdef DOXYGEN
@@ -40,13 +40,32 @@ namespace sta
 	class STM32GpioPin : public GpioPin
 	{
 	public:
+		/**
+		 * @param port  GPIO port
+		 * @param pin   Pin index
+		 */
 		STM32GpioPin(GPIO_TypeDef * port, uint16_t pin);
 
 		void setState(GpioPinState state) override;
 
+		/**
+		 * @brief Get GPIO port for pin.
+		 *
+		 * @return GPIO port
+		 */
 		GPIO_TypeDef * getPort() const;
+		/**
+		 * @brief Get pin index for pin.
+		 *
+		 * @return Pin index
+		 */
 		uint16_t getPin() const;
-		uint8_t getIndex() const;
+		/**
+		 * @brief Get GPIO port index for pin.
+		 *
+		 * @return GPIO port index
+		 */
+		uint8_t getPortIndex() const;
 
 	private:
 		GPIO_TypeDef * port_;   /**< GPIO port */
@@ -64,6 +83,13 @@ namespace sta
 		BOTH        /**< Rising and falling edge */
 	};
 
+	/**
+	 * @brief Check pin EXIT pin configuration.
+	 *
+	 * @param pin   GPIO pin
+	 * @param edge  Interrupt trigger edge
+	 * @return      True if EXIT pin and trigger edge matches
+	 */
 	bool isInterruptEdge(const STM32GpioPin & pin, InterruptEdge edge);
 } // namespace sta