--- a/src/routing/static-route-manager-impl.h Fri Jul 20 14:28:18 2007 -0700
+++ b/src/routing/static-route-manager-impl.h Mon Jul 23 14:31:24 2007 -0700
@@ -59,10 +59,11 @@
{
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 @@
* 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 @@
* @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 @@
* 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.
--- a/src/routing/static-router.h Fri Jul 20 14:28:18 2007 -0700
+++ b/src/routing/static-router.h Mon Jul 23 14:31:24 2007 -0700
@@ -40,9 +40,11 @@
{
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 @@
* 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 @@
* 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 @@
{
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 @@
*
* @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);
--- a/src/routing/wscript Fri Jul 20 14:28:18 2007 -0700
+++ b/src/routing/wscript Mon Jul 23 14:31:24 2007 -0700
@@ -13,6 +13,7 @@
'routing-environment.cc',
'static-router.cc',
'static-route-manager.cc',
+ 'static-route-manager-impl.cc',
'candidate-queue.cc',
]