doxygenation

parser/src/Line.hpp

@@ -10,7 +10,7 @@
 
 
 /*! \class Line Line.hpp "../parser/src/Line.hpp"
- * Contains the definition of a line.
+ *  \brief Line object stand for paje format syntax unit .
  */
 
 class Line{
@@ -24,29 +24,26 @@ private:
 
 public:
     /*!
-     *  \brief Constructor
-     *
-     *  Constructor for the line
+     *  \brief Constructor for the line
      */
     Line();
+
+  
     /*!
-     *  \brief Constructor
-     *  Constructor for the line
-     *  \param : A reference of the line to be copied
+     *  \brief Constructor for the line
+     *  \param A reference of the line to be copied
      */
     Line(Line &);
 
   /*!
-     *  \brief Constructor
-     *  Constructor for the line
-     *  \param : a filename
+     *  \brief  Constructor for the line
+     *  \param  a filename
      */
     Line(std::string &filename);
   
 
   /*!
-     *  \brief Constructor
-     *  Constructor for the line
+     *  \brief Constructor for the line
      *  \param : a filename
      */
     Line(const char* filename);

parser/src/TokenSource.hpp

@@ -7,7 +7,8 @@
 #include <iostream>
 
 /*! 
- * \class TokenSource supply tokens from a file trace. Tokens are word unit used in PajeFile trace formats.
+ * \class TokenSource 
+ * \brief supply tokens from a file trace. Tokens are word unit used in PajeFile trace formats.
  */
 class TokenSource{
   
@@ -31,48 +32,46 @@ private:
   void build_simple_token();
   
 public:
-
-
+  
+  
   /*!
-   *  \fn    : TokenSource
-   *  \brief : Constructor opening a file
-   *  \param : Valid filename
+   *  \fn    TokenSource(const char* filename);
+   *  \brief Constructor opening a file
+   *  \param Valid filename
    */
   TokenSource(const char* filename);
 
 
 
-
+  
   /*!
-   *  \fn : TokenSource
-   *  \brief :Constructor  needs a file to be openned later
+   *  \fn    TokenSource
+   *  \brief This constructor needs a file to be openned
    */
   TokenSource();
-
+  
 
 
   /*!
-   *  \fn : open
-   *  \brief : open a file
-   *  \param : valid filename
+   *  \fn    open()
+   *  \brief open a file
+   *  \param valid filename
    */
   void open(const char *filename);
 
 
 
-   /*!
-   *  \fn : lire_token
-   *  
-   *  \return : a token in a \0-ended character string (char*)
-   * NULL if the file ended, NULL if no file is opened
+  /*!
+   *  \fn     lire_token
+   *  \brief  supplies a token
+   *  \return a \\0-ended character string (char*), NULL if the file ended, NULL if no file is opened
    */
   char* lire_token();
 
 
    /*!
-   *  \fn : ~TokenSource
-   *  
-   *  \brief : release the file
+   *  \fn    ~TokenSource
+   *  \brief Destuctor which release the file
    */
   ~TokenSource();