F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Doxygen comment formatting and typos

Browse Source
This commit is contained in:
Eduardo Almeida
2022-10-16 14:49:21 +01:00
parent 33ff238ccb
commit 85ade4e18d
122 changed files with 1112 additions and 878 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/openflow/model/openflow-interface.h
View File

@@ -455,12 +455,15 @@ class Controller : public Object
*
* \param key The matching key data; used to create a flow that matches the packet.
* \param buffer_id The OpenFlow Buffer ID; used to run the actions on the packet if we add or
* modify the flow. \param command Whether to add, modify, or delete this flow. \param acts List
* of actions to execute. \param actions_len Length of the actions buffer. \param idle_timeout
* Flow expires if left inactive for this amount of time (specify OFP_FLOW_PERMANENT to disable
* feature). \param hard_timeout Flow expires after this amount of time (specify
* OFP_FLOW_PERMANENT to disable feature). \return Flow data that when passed to SetFlow will
* add, modify, or delete a flow it defines.
* modify the flow.
* \param command Whether to add, modify, or delete this flow.
* \param acts List of actions to execute.
* \param actions_len Length of the actions buffer.
* \param idle_timeout Flow expires if left inactive for this amount of time (specify
* OFP_FLOW_PERMANENT to disable feature).
* \param hard_timeout Flow expires after this amount of time (specify OFP_FLOW_PERMANENT to
* disable feature).
* \return Flow data that when passed to SetFlow will add, modify, or delete a flow it defines.
*/
ofp_flow_mod* BuildFlow(sw_flow_key key,
uint32_t buffer_id,

14
src/openflow/model/openflow-switch-net-device.h
View File

@@ -185,9 +185,9 @@ class OpenFlowSwitchNetDevice : public NetDevice
* \param packet_uid Packet UID; used to fetch the packet and its metadata.
* \param in_port The index of the port the Packet was initially received on.
* \param max_len The maximum number of bytes the caller wants to be sent; a value of 0
* indicates the entire packet should be sent. Used when outputting to controller. \param
* out_port The port we want to output on. \param ignore_no_fwd If true, Ports that are set to
* not forward are forced to forward.
* indicates the entire packet should be sent. Used when outputting to controller.
* \param out_port The port we want to output on.
* \param ignore_no_fwd If true, Ports that are set to not forward are forced to forward.
*/
void DoOutput(uint32_t packet_uid,
int in_port,
@@ -321,8 +321,9 @@ class OpenFlowSwitchNetDevice : public NetDevice
*
* \param packet_uid Packet UID; used to fetch the packet and its metadata.
* \param in_port The index of the port the Packet was initially received on. This port doesn't
* forward when flooding. \param flood If true, don't send out on the ports with flooding
* disabled. \return 0 if everything's ok, otherwise an error number.
* forward when flooding.
* \param flood If true, don't send out on the ports with flooding disabled.
* \return 0 if everything's ok, otherwise an error number.
*/
int OutputAll(uint32_t packet_uid, int in_port, bool flood);
@@ -355,7 +356,8 @@ class OpenFlowSwitchNetDevice : public NetDevice
* \param packet_uid Packet UID; used to fetch the packet and its metadata.
* \param in_port The index of the port the Packet was initially received on.
* \param max_len The maximum number of bytes that the caller wants to be sent; a value of 0
* indicates the entire packet should be sent. \param reason Why the packet is being sent.
* indicates the entire packet should be sent.
* \param reason Why the packet is being sent.
*/
void OutputControl(uint32_t packet_uid, int in_port, size_t max_len, int reason);