add dox documentation
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Sun, 13 May 2007 11:51:01 +0200
changeset 596 06839d2fbaa0
parent 595 3e77d7b90b9c
child 597 4c8f1400f629
add dox documentation
src/node/node-list.h
--- a/src/node/node-list.h	Sun May 13 11:46:11 2007 +0200
+++ b/src/node/node-list.h	Sun May 13 11:51:01 2007 +0200
@@ -32,17 +32,47 @@
 class TraceResolver;
 class TraceContext;
 
+/**
+ * \brief the list of simulation nodes.
+ *
+ * Every Node created is automatically added to this list.
+ */
 class NodeList
 {
 public:
   typedef ArrayTraceResolver<Node>::Index NodeIndex;
   typedef std::vector< Ptr<Node> >::iterator Iterator;
 
+  /**
+   * \param node node to add
+   * \returns index of node in list.
+   *
+   * This method is called automatically from Node::Node so
+   * the user has little reason to call it himself.
+   */
   static uint32_t Add (Ptr<Node> node);
+  /**
+   * \returns a C++ iterator located at the beginning of this
+   *          list.
+   */
   static Iterator Begin (void);
+  /**
+   * \returns a C++ iterator located at the end of this
+   *          list.
+   */
   static Iterator End (void);
+  /**
+   * \param context trace context to use for trace resolver
+   *        to create.
+   * \returns the requested trace resolver. The caller
+   *          takes ownership of the returned pointer.
+   */
   static TraceResolver *CreateTraceResolver (TraceContext const &context);
 
+  /**
+   * \param n index of requested node.
+   * \returns the Node associated to index n.
+   */
   static Ptr<Node> GetNode (uint32_t n);
 };