remove doxygen warnings, make waf work
This commit is contained in:
@@ -59,10 +59,11 @@ class SPFVertex
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @enum Enumeration of the possible types of SPFVertex objects. Currently
|
||||
* we use VertexRouter to identify objects that represent a router in the
|
||||
* simulation topology, and VertexNetwork to identify objects that represent
|
||||
* a network.
|
||||
* @brief Enumeration of the possible types of SPFVertex objects.
|
||||
*
|
||||
* Currently we use VertexRouter to identify objects that represent a router
|
||||
* in the simulation topology, and VertexNetwork to identify objects that
|
||||
* represent a network.
|
||||
*/
|
||||
enum VertexType {
|
||||
VertexUnknown = 0, /**< Uninitialized Link Record */
|
||||
@@ -124,7 +125,7 @@ public:
|
||||
* represents.
|
||||
*
|
||||
* @see VertexType
|
||||
* @param The new VertexType for the current SPFVertex object.
|
||||
* @param type The new VertexType for the current SPFVertex object.
|
||||
*/
|
||||
void SetVertexType (VertexType type);
|
||||
/**
|
||||
@@ -178,7 +179,7 @@ public:
|
||||
* @see StaticRouter::DiscoverLSAs ()
|
||||
* @warning Ownership of the LSA is transferred to the "this" SPFVertex. You
|
||||
* must not delete the LSA after calling this method.
|
||||
* @param A pointer to the StaticRouterLSA.
|
||||
* @param lsa A pointer to the StaticRouterLSA.
|
||||
*/
|
||||
void SetLSA (StaticRouterLSA* lsa);
|
||||
/**
|
||||
@@ -486,8 +487,6 @@ public:
|
||||
* the SPF tree.
|
||||
*
|
||||
* @see SPFVertex::GetNChildren
|
||||
* @param n The index (from 0 to the number of children minus 1) of the
|
||||
* child SPFVertex to return.
|
||||
* @warning Ownership of the pointer added to the children of "this"
|
||||
* SPFVertex is transferred to the "this" SPFVertex. You must not delete the
|
||||
* (now) child SPFVertex after calling this method.
|
||||
|
||||
@@ -40,9 +40,11 @@ class StaticRouterLinkRecord
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @enum Enumeration of the possible types of Static Router Link Records.
|
||||
* These are defined in the OSPF spec. We currently only use PointToPoint and
|
||||
* StubNetwork types.
|
||||
* @enum LinkType
|
||||
* @brief Enumeration of the possible types of Static Router Link Records.
|
||||
*
|
||||
* These values are defined in the OSPF spec. We currently only use
|
||||
* PointToPoint and StubNetwork types.
|
||||
*/
|
||||
enum LinkType {
|
||||
Unknown = 0, /**< Uninitialized Link Record */
|
||||
@@ -102,7 +104,7 @@ public:
|
||||
* For an OSPF type 3 link (StubNetwork), the Link ID must be the adjacent
|
||||
* neighbor's IP address
|
||||
*
|
||||
* @param An Ipv4Address to store in the Link ID field of the record.
|
||||
* @param addr An Ipv4Address to store in the Link ID field of the record.
|
||||
*/
|
||||
void SetLinkId(Ipv4Address addr);
|
||||
/**
|
||||
@@ -126,7 +128,7 @@ public:
|
||||
* For an OSPF type 3 link (StubNetwork), the Link Data must be set to the
|
||||
* network mask
|
||||
*
|
||||
* @param An Ipv4Address to store in the Link Data field of the record.
|
||||
* @param addr An Ipv4Address to store in the Link Data field of the record.
|
||||
*/
|
||||
void SetLinkData(Ipv4Address addr);
|
||||
/**
|
||||
@@ -225,7 +227,8 @@ class StaticRouterLSA
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @enum Enumeration of the possible values of the status flag in the Router
|
||||
* @enum SPFStatus
|
||||
* @brief Enumeration of the possible values of the status flag in the Router
|
||||
* Link State Advertisements.
|
||||
*/
|
||||
enum SPFStatus {
|
||||
@@ -247,7 +250,7 @@ public:
|
||||
*
|
||||
* @param status The status to of the new LSA.
|
||||
* @param linkStateId The Ipv4Address for the link state ID field.
|
||||
* @param advertisingRouter The Ipv4Address for the advertising router field.
|
||||
* @param advertisingRtr The Ipv4Address for the advertising router field.
|
||||
*/
|
||||
StaticRouterLSA(SPFStatus status, Ipv4Address linkStateId,
|
||||
Ipv4Address advertisingRtr);
|
||||
|
||||
@@ -13,6 +13,7 @@ def build(bld):
|
||||
'routing-environment.cc',
|
||||
'static-router.cc',
|
||||
'static-route-manager.cc',
|
||||
'static-route-manager-impl.cc',
|
||||
'candidate-queue.cc',
|
||||
]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user