diff --git a/src/a110x/a110x.h b/src/a110x/a110x.h index 9192f2de..754d5f4e 100644 --- a/src/a110x/a110x.h +++ b/src/a110x/a110x.h @@ -27,16 +27,29 @@ #include namespace upm { + /** + * @brief A110X Hall Effect library + * @defgroup a110x libupm-a110x + * @ingroup seeed gpio electric + */ /** - * @brief C++ API for the A110x Hall Effect sensors + * @library a110x + * @sensor a110x + * @comname A110X Hall Effect Sensor + * @altname A1101, A1102, A1103, A1004, A1106 + * @type electric + * @man seeed + * @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx + * @con gpio * - * UPM module for the A110x (A1101, A1102, A1103, A1104, and A1106) + * @brief C++ API for the A110X Hall Effect sensors + * + * UPM module for the A110X (A1101, A1102, A1103, A1104, and A1106) * Hall Effect sensors. It outputs a digital signal indicating * whether it is detecting a magnetic field with south polarity * perpendicular to the sensor element. * - * @ingroup gpio * @snippet a110x.cxx Interesting */ class A110X {