Skip to content

Commit 663d730

Browse files
committed
docs: add Doxygen comments to AUTH_* WPS auth type flag constants
1 parent 5c82a89 commit 663d730

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

src/PoliticianWPS.h

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,20 @@ inline const char* configMethodsStr(uint16_t methods) {
8585
}
8686

8787
// ─── Auth Type Flags ──────────────────────────────────────────────────────────
88-
static const uint16_t AUTH_OPEN = 0x0001;
89-
static const uint16_t AUTH_WPAPSK = 0x0002;
90-
static const uint16_t AUTH_SHARED = 0x0004;
91-
static const uint16_t AUTH_WPA = 0x0008;
92-
static const uint16_t AUTH_WPA2 = 0x0010;
93-
static const uint16_t AUTH_WPA2PSK = 0x0020;
88+
/// @defgroup wps_auth WPS Authentication Type Flags
89+
/// Bitmask values for the WPS Authentication Type attribute (ID 0x1004).
90+
/// Source: WPS specification v2.0.5, Table M-10.
91+
/// Test WpsRecord::auth_type_flags against these masks.
92+
/// @{
93+
static const uint16_t AUTH_OPEN = 0x0001; ///< Open (no authentication)
94+
static const uint16_t AUTH_WPAPSK = 0x0002; ///< WPA Personal (PSK)
95+
static const uint16_t AUTH_SHARED = 0x0004; ///< Shared Key (deprecated WEP-era)
96+
static const uint16_t AUTH_WPA = 0x0008; ///< WPA Enterprise (802.1X)
97+
static const uint16_t AUTH_WPA2 = 0x0010; ///< WPA2 Enterprise (802.1X)
98+
static const uint16_t AUTH_WPA2PSK = 0x0020; ///< WPA2 Personal (PSK)
99+
/// @}
94100

95-
// ─── Print Helper ─────────────────────────────────────────────────────────────
101+
// ─── Print Helper ─────────────────────────────────────────────────────────────────────────────
96102
/** @brief Pretty-prints a WpsRecord to any Print-compatible stream (Serial, etc.). */
97103
template<typename TStream>
98104
inline void print(TStream &out, const WpsRecord &rec) {

0 commit comments

Comments
 (0)