Skip to content

Commit

Permalink
[doxygen] remove empty line at end of block
Browse files Browse the repository at this point in the history
  • Loading branch information
jwhui committed Sep 24, 2024
1 parent d4a8e70 commit e3376b6
Show file tree
Hide file tree
Showing 62 changed files with 0 additions and 631 deletions.
6 changes: 0 additions & 6 deletions src/agent/application.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ class VendorServer;

/**
* This class implements OTBR application management.
*
*/
class Application : private NonCopyable
{
Expand All @@ -97,7 +96,6 @@ class Application : private NonCopyable
* @param[in] aEnableAutoAttach Whether or not to automatically attach to the saved network.
* @param[in] aRestListenAddress Network address to listen on.
* @param[in] aRestListenPort Network port to listen on.
*
*/
explicit Application(const std::string &aInterfaceName,
const std::vector<const char *> &aBackboneInterfaceNames,
Expand All @@ -108,13 +106,11 @@ class Application : private NonCopyable

/**
* This method initializes the Application instance.
*
*/
void Init(void);

/**
* This method de-initializes the Application instance.
*
*/
void Deinit(void);

Expand All @@ -123,7 +119,6 @@ class Application : private NonCopyable
*
* @retval OTBR_ERROR_NONE The application exited without any error.
* @retval OTBR_ERROR_ERRNO The application exited with some system error.
*
*/
otbrError Run(void);

Expand Down Expand Up @@ -246,7 +241,6 @@ class Application : private NonCopyable
* This method handles mDNS publisher's state changes.
*
* @param[in] aState The state of mDNS publisher.
*
*/
void HandleMdnsState(Mdns::Publisher::State aState);

Expand Down
30 changes: 0 additions & 30 deletions src/agent/uris.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,239 +38,209 @@ namespace otbr {

/**
* The URI Path for Address Query.
*
*/
#define OT_URI_PATH_ADDRESS_QUERY "a/aq"

/**
* @def OT_URI_PATH_ADDRESS_NOTIFY
*
* The URI Path for Address Notify.
*
*/
#define OT_URI_PATH_ADDRESS_NOTIFY "a/an"

/**
* @def OT_URI_PATH_ADDRESS_ERROR
*
* The URI Path for Address Error.
*
*/
#define OT_URI_PATH_ADDRESS_ERROR "a/ae"

/**
* @def OT_URI_PATH_ADDRESS_RELEASE
*
* The URI Path for Address Release.
*
*/
#define OT_URI_PATH_ADDRESS_RELEASE "a/ar"

/**
* @def OT_URI_PATH_ADDRESS_SOLICIT
*
* The URI Path for Address Solicit.
*
*/
#define OT_URI_PATH_ADDRESS_SOLICIT "a/as"

/**
* @def OT_URI_PATH_ACTIVE_GET
*
* The URI Path for MGMT_ACTIVE_GET
*
*/
#define OT_URI_PATH_ACTIVE_GET "c/ag"

/**
* @def OT_URI_PATH_ACTIVE_SET
*
* The URI Path for MGMT_ACTIVE_SET
*
*/
#define OT_URI_PATH_ACTIVE_SET "c/as"

/**
* @def OT_URI_PATH_DATASET_CHANGED
*
* The URI Path for MGMT_DATASET_CHANGED
*
*/
#define OT_URI_PATH_DATASET_CHANGED "c/dc"

/**
* @def OT_URI_PATH_ENERGY_SCAN
*
* The URI Path for Energy Scan
*
*/
#define OT_URI_PATH_ENERGY_SCAN "c/es"

/**
* @def OT_URI_PATH_ENERGY_REPORT
*
* The URI Path for Energy Report
*
*/
#define OT_URI_PATH_ENERGY_REPORT "c/er"

/**
* @def OT_URI_PATH_PENDING_GET
*
* The URI Path for MGMT_PENDING_GET
*
*/
#define OT_URI_PATH_PENDING_GET "c/pg"

/**
* @def OT_URI_PATH_PENDING_SET
*
* The URI Path for MGMT_PENDING_SET
*
*/
#define OT_URI_PATH_PENDING_SET "c/ps"

/**
* @def OT_URI_PATH_SERVER_DATA
*
* The URI Path for Server Data Registration.
*
*/
#define OT_URI_PATH_SERVER_DATA "a/sd"

/**
* @def OT_URI_PATH_ANNOUNCE_BEGIN
*
* The URI Path for Announce Begin.
*
*/
#define OT_URI_PATH_ANNOUNCE_BEGIN "c/ab"

/**
* @def OT_URI_PATH_RELAY_RX
*
* The URI Path for Relay RX.
*
*/
#define OT_URI_PATH_RELAY_RX "c/rx"

/**
* @def OT_URI_PATH_RELAY_TX
*
* The URI Path for Relay TX.
*
*/
#define OT_URI_PATH_RELAY_TX "c/tx"

/**
* @def OT_URI_PATH_JOINER_FINALIZE
*
* The URI Path for Joiner Finalize
*
*/
#define OT_URI_PATH_JOINER_FINALIZE "c/jf"

/**
* @def OT_URI_PATH_JOINER_ENTRUST
*
* The URI Path for Joiner Entrust
*
*/
#define OT_URI_PATH_JOINER_ENTRUST "c/je"

/**
* @def OT_URI_PATH_LEADER_PETITION
*
* The URI Path for Leader Petition
*
*/
#define OT_URI_PATH_LEADER_PETITION "c/lp"

/**
* @def OT_URI_PATH_LEADER_KEEP_ALIVE
*
* The URI Path for Leader Keep Alive
*
*/
#define OT_URI_PATH_LEADER_KEEP_ALIVE "c/la"

/**
* @def OT_URI_PATH_PANID_CONFLICT
*
* The URI Path for PAN ID Conflict
*
*/
#define OT_URI_PATH_PANID_CONFLICT "c/pc"

/**
* @def OT_URI_PATH_PANID_QUERY
*
* The URI Path for PAN ID Query
*
*/
#define OT_URI_PATH_PANID_QUERY "c/pq"

/**
* @def OT_URI_PATH_COMMISSIONER_GET
*
* The URI Path for MGMT_COMMISSIONER_GET
*
*/
#define OT_URI_PATH_COMMISSIONER_GET "c/cg"

/**
* @def OT_URI_PATH_COMMISSIONER_SET
*
* The URI Path for MGMT_COMMISSIONER_SET
*
*/
#define OT_URI_PATH_COMMISSIONER_SET "c/cs"

/**
* @def OT_URI_PATH_COMMISSIONER_PETITION
*
* The URI Path for Commissioner Petition.
*
*/
#define OT_URI_PATH_COMMISSIONER_PETITION "c/cp"

/**
* @def OT_URI_PATH_COMMISSIONER_KEEP_ALIVE
*
* The URI Path for Commissioner Keep Alive.
*
*/
#define OT_URI_PATH_COMMISSIONER_KEEP_ALIVE "c/ca"

/**
* @def OT_URI_PATH_DIAGNOSTIC_GET_REQUEST
*
* The URI Path for Network Diagnostic Get Request.
*
*/
#define OT_URI_PATH_DIAGNOSTIC_GET_REQUEST "d/dg"

/**
* @def OT_URI_PATH_DIAGNOSTIC_GET_QUERY
*
* The URI Path for Network Diagnostic Get Query.
*
*/
#define OT_URI_PATH_DIAGNOSTIC_GET_QUERY "d/dq"

/**
* @def OT_URI_PATH_DIAGNOSTIC_GET_ANSWER
*
* The URI Path for Network Diagnostic Get Answer.
*
*/
#define OT_URI_PATH_DIAGNOSTIC_GET_ANSWER "d/da"

/**
* @def OT_URI_PATH_DIAG_RST
*
* The URI Path for Network Diagnostic Reset.
*
*/
#define OT_URI_PATH_DIAGNOSTIC_RESET "d/dr"

Expand Down
3 changes: 0 additions & 3 deletions src/backbone_router/backbone_agent.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ namespace BackboneRouter {

/**
* This class implements Thread Backbone agent functionality.
*
*/
class BackboneAgent : private NonCopyable
{
Expand All @@ -74,13 +73,11 @@ class BackboneAgent : private NonCopyable
* This constructor intiializes the `BackboneAgent` instance.
*
* @param[in] aHost The Thread controller instance.
*
*/
BackboneAgent(otbr::Ncp::RcpHost &aHost, std::string aInterfaceName, std::string aBackboneInterfaceName);

/**
* This method initializes the Backbone agent.
*
*/
void Init(void);

Expand Down
1 change: 0 additions & 1 deletion src/backbone_router/constants.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ namespace BackboneRouter {

/**
* Backbone configurations.
*
*/
enum
{
Expand Down
4 changes: 0 additions & 4 deletions src/backbone_router/dua_routing_manager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,12 @@ namespace BackboneRouter {

/**
* This class implements the DUA routing manager.
*
*/
class DuaRoutingManager : private NonCopyable
{
public:
/**
* This constructor initializes a DUA routing manager instance.
*
*/
explicit DuaRoutingManager(std::string aInterfaceName, std::string aBackboneInterfaceName)
: mEnabled(false)
Expand All @@ -78,13 +76,11 @@ class DuaRoutingManager : private NonCopyable

/**
* This method enables the DUA routing manager.
*
*/
void Enable(const Ip6Prefix &aDomainPrefix);

/**
* This method disables the DUA routing manager.
*
*/
void Disable(void);

Expand Down
7 changes: 0 additions & 7 deletions src/backbone_router/nd_proxy.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,12 @@ namespace BackboneRouter {

/**
* This class implements ND Proxy manager.
*
*/
class NdProxyManager : public MainloopProcessor, private NonCopyable
{
public:
/**
* This constructor initializes a NdProxyManager instance.
*
*/
explicit NdProxyManager(otbr::Ncp::RcpHost &aHost, std::string aBackboneInterfaceName)
: mHost(aHost)
Expand All @@ -92,21 +90,18 @@ class NdProxyManager : public MainloopProcessor, private NonCopyable

/**
* This method initializes a ND Proxy manager instance.
*
*/
void Init(void);

/**
* This method enables the ND Proxy manager.
*
* @param[in] aDomainPrefix The Domain Prefix.
*
*/
void Enable(const Ip6Prefix &aDomainPrefix);

/**
* This method disables the ND Proxy manager.
*
*/
void Disable(void);

Expand All @@ -119,15 +114,13 @@ class NdProxyManager : public MainloopProcessor, private NonCopyable
* @param[in] aEvent The Backbone Router ND Proxy event type.
* @param[in] aDua The Domain Unicast Address of the ND Proxy, or `nullptr` if @p `aEvent` is
* `OT_BACKBONE_ROUTER_NDPROXY_CLEARED`.
*
*/
void HandleBackboneRouterNdProxyEvent(otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua);

/**
* This method returns if the ND Proxy manager is enabled.
*
* @returns If the ND Proxy manager is enabled;
*
*/
bool IsEnabled(void) const { return mIcmp6RawSock >= 0; }

Expand Down
Loading

0 comments on commit e3376b6

Please sign in to comment.