Doxygenate \internal
authorPeter D. Barnes, Jr. <barnes26@llnl.gov>
Wed, 03 Jul 2013 15:05:17 -0700
changeset 9896 f91da274b215
parent 9895 7a448f745b9d
child 9897 aeba2c49686b
Doxygenate \internal
doc/doxygen.conf
src/aodv/test/aodv-regression.h
src/aodv/test/bug-772.h
src/mesh/test/dot11s/hwmp-proactive-regression.h
src/mesh/test/dot11s/hwmp-reactive-regression.h
src/mesh/test/dot11s/hwmp-simplest-regression.h
src/mesh/test/dot11s/hwmp-target-flags-regression.h
src/mesh/test/dot11s/pmp-regression.h
src/mesh/test/flame/flame-regression.h
--- a/doc/doxygen.conf	Wed Jul 03 14:45:39 2013 -0700
+++ b/doc/doxygen.conf	Wed Jul 03 15:05:17 2013 -0700
@@ -196,7 +196,7 @@
 ALIASES                = 
 
 # Set off \internal docs
-ALIASES               += intern="\internal \par \b Internal:"
+ALIASES               += internal="\par \b Internal:"
 
 # Typeset parameter name in docs as in the "Parameters:" list
 # Usage:     /** \param [in/out] tag If found, \pname{tag} is ... */
--- a/src/aodv/test/aodv-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/aodv/test/aodv-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -165,7 +165,7 @@
   ~ChainRegressionTest ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
 
   /// PCAP file names prefix
--- a/src/aodv/test/bug-772.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/aodv/test/bug-772.h	Wed Jul 03 15:05:17 2013 -0700
@@ -50,7 +50,7 @@
   ~Bug772ChainTest ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
 
   /// PCAP file names prefix
--- a/src/mesh/test/dot11s/hwmp-proactive-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/dot11s/hwmp-proactive-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -64,7 +64,7 @@
   void CheckResults ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;
--- a/src/mesh/test/dot11s/hwmp-reactive-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/dot11s/hwmp-reactive-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -77,7 +77,7 @@
   virtual void DoRun ();
   void CheckResults ();
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;
--- a/src/mesh/test/dot11s/hwmp-simplest-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/dot11s/hwmp-simplest-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -75,7 +75,7 @@
   void CheckResults ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;
--- a/src/mesh/test/dot11s/hwmp-target-flags-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/dot11s/hwmp-target-flags-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -74,7 +74,7 @@
   void CheckResults ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;
--- a/src/mesh/test/dot11s/pmp-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/dot11s/pmp-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -49,7 +49,7 @@
   ~PeerManagementProtocolRegressionTest ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;
--- a/src/mesh/test/flame/flame-regression.h	Wed Jul 03 14:45:39 2013 -0700
+++ b/src/mesh/test/flame/flame-regression.h	Wed Jul 03 15:05:17 2013 -0700
@@ -63,7 +63,7 @@
   void CheckResults ();
 
 private:
-  /// XXX It is important to have pointers here
+  /// \internal It is important to have pointers here
   NodeContainer * m_nodes;
   /// Simulation time
   Time m_time;