Have doxygen produce links to enum class type using ::EnumClassType (however, link to its value fails)

Note: I had no success to have doxygen produce links to 'enum class' values,
i.e. '::BTSecurityLevel::NONE' and all permutations of '::' and '#' did not succeed.

5 files changed, 46 insertions, 46 deletions

diff --git a/api/direct_bt/ATTPDUTypes.hpp b/api/direct_bt/ATTPDUTypes.hpp
index 3770a699..66e3c32a 100644
--- a/api/direct_bt/ATTPDUTypes.hpp
+++ b/api/direct_bt/ATTPDUTypes.hpp
@@ -51,7 +51,7 @@
  *
  * Direct-BT implements the following layers
  * - DBTManager for adapter configuration and adapter add/removal notifications (ChangedAdapterSetFunc())
- *   - Using *BlueZ Kernel Manager Control Channel*
+ *   - Using *BlueZ Kernel Manager Control Channel* via MgmtMsg communication.
  * - *HCI Handling* via HCIHandler using HCIPacket implementing connect/disconnect w/ tracking, device discovery, etc
  * - *ATT PDU* AttPDUMsg via L2CAP for low level packet communication
  * - *GATT Support* via GATTHandler using AttPDUMsg over L2CAPComm, providing
@@ -63,8 +63,8 @@
  *   - LE Secure Connections
  *   - LE legacy pairing
  * - On Linux/BlueZ, LE Secure Connections and LE legacy pairing is supported using
- *   - BTSecurityLevel setting via DBTDevice/L2CAPComm per connection and
- *   - SMPIOCapability via DBTManager (per adapter) and DBTDevice (per connection)
+ *   - ::BTSecurityLevel setting via DBTDevice / L2CAPComm per connection and
+ *   - ::SMPIOCapability via DBTManager (per adapter) and DBTDevice (per connection)
  *   - SMPPDUMsg SMP event tracking over HCI/ACL/L2CAP, observing operations
  *
  * DBTManager utilizes the *BlueZ Kernel Manager Control Channel*
diff --git a/api/direct_bt/DBTAdapter.hpp b/api/direct_bt/DBTAdapter.hpp
index f6f159a5..868c8485 100644
--- a/api/direct_bt/DBTAdapter.hpp
+++ b/api/direct_bt/DBTAdapter.hpp
@@ -130,10 +130,10 @@ namespace direct_bt {
             virtual void deviceConnected(std::shared_ptr<DBTDevice> device, const uint16_t handle, const uint64_t timestamp) = 0;
 
             /**
-             * An already connected DBTDevice's SMPPairingState has changed.
+             * An already connected DBTDevice's ::SMPPairingState has changed.
              * @param device the device which PairingMode has been changed.
-             * @param state the current SMPPairingState of the connected device, see DBTDevice::getCurrentPairingState()
-             * @param mode the current PairingMode of the connected device, see DBTDevice::getCurrentPairingMode()
+             * @param state the current ::SMPPairingState of the connected device, see DBTDevice::getCurrentPairingState()
+             * @param mode the current ::PairingMode of the connected device, see DBTDevice::getCurrentPairingMode()
              * @param timestamp the time in monotonic milliseconds when this event occurred. See BasicTypes::getCurrentMilliseconds().
              * @see DBTDevice::setPairingPasskey()
              * @see DBTDevice::setPairingNumericComparison()
diff --git a/api/direct_bt/DBTDevice.hpp b/api/direct_bt/DBTDevice.hpp
index 759add9d..2ceaf62c 100644
--- a/api/direct_bt/DBTDevice.hpp
+++ b/api/direct_bt/DBTDevice.hpp
@@ -430,18 +430,18 @@ namespace direct_bt {
             HCIStatusCode disconnect(const HCIStatusCode reason=HCIStatusCode::REMOTE_USER_TERMINATED_CONNECTION ) noexcept;
 
             /**
-             * Set the BTSecurityLevel used to connect to this device.
+             * Set the ::BTSecurityLevel used to connect to this device.
              * <p>
              * Method returns false if this device has already being connected,
              * or DBTDevice::connectLE() or DBTDevice::connectBREDR() has been issued already.
              * </p>
              * <p>
              * To ensure consistent no authentication setup,<br>
-             * implementation will set SMPIOCapability::NO_INPUT_NO_OUTPUT if sec_level <= BTSecurityLevel::ENC_ONLY<br>
-             * and DBTDevice::setConnIOCapability() not used.
+             * implementation will set ::SMPIOCapability::NO_INPUT_NO_OUTPUT if sec_level <= ::BTSecurityLevel::ENC_ONLY<br>
+             * and DBTDevice::setConnIOCapability() has not been used.
              * </p>
-             * @param sec_level BTSecurityLevel to be applied
-             * @param blocking if true, blocks until previous SMPIOCapability setting is completed,
+             * @param sec_level ::BTSecurityLevel to be applied
+             * @param blocking if true, blocks until previous ::SMPIOCapability setting is completed,
              *        i.e. until connection has been completed or failed.
              *        Otherwise returns immediately with false if previous connection result is still pending.
              * @return
@@ -449,59 +449,59 @@ namespace direct_bt {
             bool setConnSecurityLevel(const BTSecurityLevel sec_level, const bool blocking) noexcept;
 
             /**
-             * Return the BTSecurityLevel, determined when connection is established.
+             * Return the ::BTSecurityLevel, determined when connection is established.
              */
             BTSecurityLevel getConnSecurityLevel() const noexcept { return pairing_data.sec_level_conn; }
 
             /**
-             * Sets the given SMPIOCapability used to connect to this device.
+             * Sets the given ::SMPIOCapability used to connect to this device.
              * <p>
              * Method returns false if operation fails, this device has already being connected,
              * or DBTDevice::connectLE() or DBTDevice::connectBREDR() has been issued already.
              * </p>
              * <p>
-             * The SMPIOCapability value will be reset to its previous value when connection is completed or failed.
+             * The ::SMPIOCapability value will be reset for the adapter to its previous value when connection is completed or failed.
              * </p>
-             * @param io_cap SMPIOCapability to be applied
-             * @param blocking if true, blocks until previous SMPIOCapability setting is completed,
+             * @param io_cap ::SMPIOCapability to be applied
+             * @param blocking if true, blocks until previous ::SMPIOCapability setting is completed,
              *        i.e. until connection has been completed or failed.
              *        Otherwise returns immediately with false if previous connection result is still pending.
              */
             bool setConnIOCapability(const SMPIOCapability io_cap, const bool blocking=true) noexcept;
 
             /**
-             * Sets the given BTSecurityLevel and SMPIOCapability used to connect to this device.
+             * Sets the given ::BTSecurityLevel and ::SMPIOCapability used to connect to this device.
              * <p>
              * Method returns false if operation fails, this device has already being connected,
              * or DBTDevice::connectLE() or DBTDevice::connectBREDR() has been issued already.
              * </p>
              * <p>
-             * The SMPIOCapability value will be reset to its previous value when connection is completed or failed.
+             * The ::SMPIOCapability value will be reset for the adapter to its previous value when connection is completed or failed.
              * </p>
-             * @param sec_level BTSecurityLevel to be applied
-             * @param io_cap SMPIOCapability to be applied
-             * @param blocking if true, blocks until previous SMPIOCapability setting is completed,
+             * @param sec_level ::BTSecurityLevel to be applied
+             * @param io_cap ::SMPIOCapability to be applied
+             * @param blocking if true, blocks until previous ::SMPIOCapability setting is completed,
              *        i.e. until connection has been completed or failed.
              *        Otherwise returns immediately with false if previous connection result is still pending.
              */
             bool setConnSecurity(const BTSecurityLevel sec_level, const SMPIOCapability io_cap, const bool blocking=true) noexcept;
 
             /**
-             * Return the set SMPIOCapability value, determined when connection is established.
+             * Return the set ::SMPIOCapability value, determined when connection is established.
              */
             SMPIOCapability getConnIOCapability() const noexcept { return pairing_data.ioCap_conn; }
 
             /**
-             * Method sets the given passkey entry, see PairingMode::PASSKEY_ENTRY_ini.
+             * Method sets the given passkey entry, see ::PairingMode::PASSKEY_ENTRY_ini.
              * <p>
-             * Call this method if the device shall be securely paired with PairingMode::PASSKEY_ENTRY_ini,
-             * i.e. when notified via AdapterStatusListener::devicePairingState() in state SMPPairingState::PASSKEY_EXPECTED.
+             * Call this method if the device shall be securely paired with ::PairingMode::PASSKEY_ENTRY_ini,
+             * i.e. when notified via AdapterStatusListener::devicePairingState() in state ::SMPPairingState::PASSKEY_EXPECTED.
              * </p>
              *
-             * @param passkey used for PairingMode::PASSKEY_ENTRY_ini method.
+             * @param passkey used for ::PairingMode::PASSKEY_ENTRY_ini method.
              *        Will be encrypted before sending to counter-party.
              *
-             * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise HCIStatusCode may disclose reason for rejection.
+             * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise ::HCIStatusCode may disclose reason for rejection.
              * @see PairingMode
              * @see SMPPairingState
              * @see AdapterStatusListener::devicePairingState()
@@ -515,16 +515,16 @@ namespace direct_bt {
             HCIStatusCode setPairingPasskeyNegative() noexcept;
 
             /**
-             * Method sets the numeric comparison result, see PairingMode::NUMERIC_COMPARE_ini.
+             * Method sets the numeric comparison result, see ::PairingMode::NUMERIC_COMPARE_ini.
              * <p>
-             * Call this method if the device shall be securely paired with PairingMode::NUMERIC_COMPARE_ini,
-             * i.e. when notified via AdapterStatusListener::devicePairingState() in state SMPPairingState::NUMERIC_COMPARE_EXPECTED.
+             * Call this method if the device shall be securely paired with ::PairingMode::NUMERIC_COMPARE_ini,
+             * i.e. when notified via AdapterStatusListener::devicePairingState() in state ::SMPPairingState::NUMERIC_COMPARE_EXPECTED.
              * </p>
              *
-             * @param equal used for PairingMode::NUMERIC_COMPARE_ini method.
+             * @param equal used for ::PairingMode::NUMERIC_COMPARE_ini method.
              *        Will be encrypted before sending to counter-party.
              *
-             * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise HCIStatusCode may disclose reason for rejection.
+             * @return HCIStatusCode::SUCCESS if the command has been accepted, otherwise ::HCIStatusCode may disclose reason for rejection.
              * @see PairingMode
              * @see SMPPairingState
              * @see AdapterStatusListener::devicePairingState()
@@ -536,19 +536,19 @@ namespace direct_bt {
             HCIStatusCode setPairingNumericComparison(const bool equal) noexcept;
 
             /**
-             * Returns the current PairingMode used by the device.
+             * Returns the current ::PairingMode used by the device.
              * <p>
-             * If the device is not paired, the current mode is PairingMode::NONE.
+             * If the device is not paired, the current mode is ::PairingMode::NONE.
              * </p>
              * <p>
-             * If the Pairing Feature Exchange is completed, i.e. SMPPairingState::FEATURE_EXCHANGE_COMPLETED,
+             * If the Pairing Feature Exchange is completed, i.e. ::SMPPairingState::FEATURE_EXCHANGE_COMPLETED,
              * as notified by AdapterStatusListener::devicePairingState(),
              * the current mode reflects the currently used PairingMode.
              * </p>
              * <p>
-             * In case the Pairing Feature Exchange is in progress, the current mode is PairingMode::NEGOTIATING.
+             * In case the Pairing Feature Exchange is in progress, the current mode is ::PairingMode::NEGOTIATING.
              * </p>
-             * @return current PairingMode.
+             * @return current ::PairingMode.
              * @see PairingMode
              * @see SMPPairingState
              * @see AdapterStatusListener::devicePairingState()
@@ -560,9 +560,9 @@ namespace direct_bt {
             PairingMode getPairingMode() const noexcept { return pairing_data.mode; }
 
             /**
-             * Returns the current SMPPairingState.
+             * Returns the current ::SMPPairingState.
              * <p>
-             * If the device is not paired, the current state is SMPPairingState::NONE.
+             * If the device is not paired, the current state is ::SMPPairingState::NONE.
              * </p>
              * @see PairingMode
              * @see SMPPairingState
diff --git a/api/direct_bt/L2CAPComm.hpp b/api/direct_bt/L2CAPComm.hpp
index 21719d7f..d16235ff 100644
--- a/api/direct_bt/L2CAPComm.hpp
+++ b/api/direct_bt/L2CAPComm.hpp
@@ -184,20 +184,20 @@ namespace direct_bt {
             std::recursive_mutex & mutex_write() { return mtx_write; }
 
             /**
-             * If sec_level > BTSecurityLevel::UNSET, sets the BlueZ's L2CAP socket BT_SECURITY sec_level, determining the SMP security mode per connection.
+             * If sec_level > ::BTSecurityLevel::UNSET, sets the BlueZ's L2CAP socket BT_SECURITY sec_level, determining the SMP security mode per connection.
              * <p>
              * To unset security, the L2CAP socket should be closed and opened again.
              * </p>
              *
-             * @param sec_level sec_level < BTSecurityLevel::NONE will not set security level and returns false.
-             * @return true if a security level > BTSecurityLevel::UNSET has been set successfully, false if no security level has been set or if it failed.
+             * @param sec_level sec_level < ::BTSecurityLevel::NONE will not set security level and returns false.
+             * @return true if a security level > ::BTSecurityLevel::UNSET has been set successfully, false if no security level has been set or if it failed.
              */
             bool setBTSecurityLevel(const BTSecurityLevel sec_level);
 
             /**
              * Fetches the current BlueZ's L2CAP socket BT_SECURITY sec_level.
              *
-             * @return BTSecurityLevel  sec_level value, BTSecurityLevel::UNSET if failure
+             * @return ::BTSecurityLevel  sec_level value, ::BTSecurityLevel::UNSET if failure
              */
             BTSecurityLevel getBTSecurityLevel();
 
diff --git a/api/direct_bt/SMPHandler.hpp b/api/direct_bt/SMPHandler.hpp
index 891547ea..c1f62865 100644
--- a/api/direct_bt/SMPHandler.hpp
+++ b/api/direct_bt/SMPHandler.hpp
@@ -216,10 +216,10 @@ namespace direct_bt {
             std::string getStateString() const noexcept { return L2CAPComm::getStateString(is_connected, has_ioerror); }
 
             /**
-             * If sec_level > BTSecurityLevel::UNSET, change security level per L2CAP connection.
+             * If sec_level > ::BTSecurityLevel::UNSET, change security level per L2CAP connection.
              *
-             * @param sec_level sec_level < BTSecurityLevel::NONE will not set security level and returns false.
-             * @return true if a security level > BTSecurityLevel::UNSET has been set successfully, false if no security level has been set or if it failed.
+             * @param sec_level sec_level < ::BTSecurityLevel::NONE will not set security level and returns false.
+             * @return true if a security level > ::BTSecurityLevel::UNSET has been set successfully, false if no security level has been set or if it failed.
              */
             bool establishSecurity(const BTSecurityLevel sec_level);