Adding comments to Linux CCN examples

[nepi.git] / src / nepi / execution / trace.py

diff --git a/src/nepi/execution/trace.py b/src/nepi/execution/trace.py
index 382a6bb..19065db 100644 (file)
--- a/src/nepi/execution/trace.py
+++ b/src/nepi/execution/trace.py
@@ -1,10 +1,42 @@
+#
+#    NEPI, a framework to manage network experiments
+#    Copyright (C) 2013 INRIA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+
 class TraceAttr:
+    """ Trace attributes represent different information
+    aspects that can be retrieved from a trace.
+    """
     ALL = 'all'
     STREAM = 'stream'
     PATH = 'path'
     SIZE = 'size'
 
 class Trace(object):
+    """
+    .. class:: Class Args :
+      
+        :param name: Name of the trace
+        :type name: str
+        :param help: Help about the trace
+        :type help: str
+
+    """
+
     def __init__(self, name, help):
         self._name = name
         self._help = help
@@ -12,9 +44,11 @@ class Trace(object):
 
     @property
     def name(self):
+        """ Returns the name of the trace """
         return self._name
 
     @property
     def help(self):
+        """ Returns the help of the trace """
         return self._help