From 93ad9161ec91ce70090baa131ef41195056f24bb Mon Sep 17 00:00:00 2001
From: "Gustavo J. A. M. Carneiro" <gjc@inescporto.pt>
Date: Tue, 31 Jul 2007 11:53:11 +0100
Subject: [PATCH] Fix the OLSR documentation.

---
 doc/doxygen.conf              |  3 +++
 doc/main.txt                  |  2 +-
 src/routing/olsr/olsr-agent.h | 22 ++++++++++++++++++++--
 src/routing/olsr/olsr.h       | 12 +++++++++---
 4 files changed, 33 insertions(+), 6 deletions(-)

diff --git a/doc/doxygen.conf b/doc/doxygen.conf
index a8b337f0a..d71b47412 100644
--- a/doc/doxygen.conf
+++ b/doc/doxygen.conf
@@ -472,6 +472,9 @@ RECURSIVE              = YES
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
 EXCLUDE                = \
+ src/routing/olsr/olsr-state.h \
+ src/routing/olsr/repositories.h \
+ src/routing/olsr/routing-table.h \
  src/simulator/high-precision.h \
  src/simulator/high-precision-128.h \
  src/simulator/high-precision-double.h
diff --git a/doc/main.txt b/doc/main.txt
index 3fc144687..b492641b8 100644
--- a/doc/main.txt
+++ b/doc/main.txt
@@ -65,4 +65,4 @@
 /**
  * \defgroup constants Constants
  * \brief Constants you can change
- */
\ No newline at end of file
+ */
diff --git a/src/routing/olsr/olsr-agent.h b/src/routing/olsr/olsr-agent.h
index 398dc4c34..2a88f31c1 100644
--- a/src/routing/olsr/olsr-agent.h
+++ b/src/routing/olsr/olsr-agent.h
@@ -28,13 +28,30 @@
 namespace ns3 {
 
 
+/**
+ * \brief Class implementing the OLSR state machine
+ *
+ * This class represents an instance of the OLSR protocol.  It
+ * attaches itself to a Node, and its lifecycle is bound to that node.
+ * Normally the functions in the ns3::olsr namespace are more simple
+ * to use to start OLSR on nodes, but access to the underlying OLSR
+ * agent can be useful in order to customize the OLSR parameters.
+ * Example:
+ *
+ * \code
+ * Ptr<OlsrAgent> olsr = ComponentManager::Create<OlsrAgent, Ptr<Node> > (OlsrAgent::cid, OlsrAgent::iid, node);
+ * agent->SetMainInterface (2);
+ * agent->Start ();
+ * \endcode
+ */
 class OlsrAgent : public Object
 {
 public:
   static const InterfaceId iid;
   static const ClassId cid;
 
-  /* \brief Sets the main interface to be used by OLSR
+  /**
+   * \brief Sets the main interface to be used by OLSR
    *
    * Normally OLSR supports multiple interfaces, but the protocol
    * requires the definition of a "main interface".  This interface's
@@ -48,7 +65,8 @@ public:
    */
   virtual void SetMainInterface (uint32_t interface) = 0;
 
-  /* \brief Starts the OLSR protocol operation
+  /**
+   * \brief Starts the OLSR protocol operation
    *
    * Calling this method essentially bootstraps the OLSR protocol, and
    * causes the agent to start broadcasting OLSR messages to
diff --git a/src/routing/olsr/olsr.h b/src/routing/olsr/olsr.h
index b06c63097..cbfa40c44 100644
--- a/src/routing/olsr/olsr.h
+++ b/src/routing/olsr/olsr.h
@@ -26,16 +26,22 @@
 
 namespace ns3
 {
+  /**
+   * \namespace ns3::olsr
+   * \brief Includes a set of utility functions to enable OLSR on
+   * certain nodes with default parameters.  For finer grained control
+   * of OLSR parameters, see OlsrAgent.
+   */
   namespace olsr
   {
-    // \brief Start the OLSR routing agent on all nodes
+    /// \brief Start the OLSR routing agent on all nodes
     void EnableAllNodes (void);
 
-    // \brief Start the OLSR routing agent on a given list of nodes
+    /// \brief Start the OLSR routing agent on a given list of nodes
     template <typename InputIterator>
     void EnableNodes (InputIterator begin, InputIterator end);
 
-    // \brief Start the OLSR routing agent on the given nodes
+    /// \brief Start the OLSR routing agent on the given node
     void EnableNode (Ptr<Node> node);
   }
 }