Fix some doxygen errors
authorTom Henderson <tomh@tomh.org>
Wed, 17 Aug 2011 16:55:53 -0700
changeset 7445 13f0b82f19e7
parent 7444 075e6cbaa9d9
child 7446 e20e42e74605
Fix some doxygen errors
src/core/model/callback.h
src/core/model/command-line.h
src/core/model/nstime.h
src/core/model/random-variable.h
src/core/model/scheduler.h
src/core/model/simple-ref-count.h
src/core/model/simulator.h
--- a/src/core/model/callback.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/callback.h	Wed Aug 17 16:55:53 2011 -0700
@@ -357,7 +357,7 @@
  *
  * Sample code which shows how to use this class template 
  * as well as the function templates \ref MakeCallback :
- * \include samples/main-callback.cc
+ * \include src/core/examples/main-callback.cc
  */
 
 template<typename R, 
--- a/src/core/model/command-line.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/command-line.h	Wed Aug 17 16:55:53 2011 -0700
@@ -37,9 +37,9 @@
  * CommandLine::AddValue but the most important functionality
  * provided by this class is that it can be used to set the
  * 'initial value' of every attribute in the system with the
- * --TypeIdName::AttributeName=value syntax and it can be used
+ * '\--TypeIdName::AttributeName=value' syntax and it can be used
  * to set the value of every GlobalValue in the system with
- * the --GlobalValueName=value syntax.
+ * the \--GlobalValueName=value syntax.
  */
 class CommandLine
 {
--- a/src/core/model/nstime.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/nstime.h	Wed Aug 17 16:55:53 2011 -0700
@@ -358,7 +358,6 @@
     return Time (value);
   }
   /**
-   * \param time a Time object
    * \param timeUnit the unit of the value to return
    *
    * Convert the input time into an integer value according to the requested
@@ -390,7 +389,6 @@
     return From (int64x64_t (value), timeUnit);
   }
   /**
-   * \param time a Time object
    * \param timeUnit the unit of the value to return
    *
    * Convert the input time into a floating point value according to the requested
--- a/src/core/model/random-variable.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/random-variable.h	Wed Aug 17 16:55:53 2011 -0700
@@ -133,7 +133,7 @@
 
   /**
    * \brief Returns a random integer integer from the underlying distribution
-   * \return  Integer cast of ::GetValue()
+   * \return  Integer cast of RandomVariable::GetValue
    */
   uint32_t GetInteger (void) const;
 
@@ -571,7 +571,7 @@
    * \brief Constructor
    *
    * Creates a generator that returns successive elements of the d array
-   * on successive calls to ::Value().  Note that the d pointer is copied
+   * on successive calls to RandomVariable::GetValue.  Note that the d pointer is copied
    * for use by the generator (shallow-copy), not its contents, so the
    * contents of the array d points to have to remain unchanged for the use
    * of DeterministicVariable to be meaningful.
--- a/src/core/model/scheduler.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/scheduler.h	Wed Aug 17 16:55:53 2011 -0700
@@ -46,8 +46,8 @@
  * The lifetime of this pointer is assumed to always be longer than
  * the lifetime of the Scheduler class which means that the caller
  * is responsible for ensuring that this invariant holds through
- * calling EventImpl::Ref and EventImpl::Unref at the right time.
- * Typically, ::Ref is called before Insert and ::Unref is called
+ * calling EventId::Ref and SimpleRefCount::Unref at the right time.
+ * Typically, EventId::Ref is called before Insert and SimpleRefCount::Unref is called
  * after a call to one of the Remove methods.
  */
 class Scheduler : public Object
--- a/src/core/model/simple-ref-count.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/simple-ref-count.h	Wed Aug 17 16:55:53 2011 -0700
@@ -49,7 +49,7 @@
  *      class. Yes, this is weird but it's a common C++ template pattern
  *      whose name is CRTP (Curiously Recursive Template Pattern)
  *    - PARENT: the typename of the parent of this template. By default,
- *      this typename is 'ns3::empty' which is an empty class: compilers
+ *      this typename is "'ns3::empty'" which is an empty class: compilers
  *      which implement the RBCO optimization (empty base class optimization)
  *      will make this a no-op
  *    - DELETER: the typename of a class which implements a public static 
--- a/src/core/model/simulator.h	Wed Aug 17 16:50:38 2011 -0700
+++ b/src/core/model/simulator.h	Wed Aug 17 16:55:53 2011 -0700
@@ -53,7 +53,7 @@
  * 
  * A simple example of how to use the Simulator class to schedule events
  * is shown below:
- * \include samples/main-simulator.cc
+ * \include src/core/examples/sample-simulator.cc
  */
 class Simulator 
 {