Commit 9d151304 authored by Johnny Jazeix's avatar Johnny Jazeix
Browse files

Ajout de commentaires et de code.

parent a94264e6
......@@ -513,7 +513,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = interface/src/ interface/tests/ parser/src/ trace/src/ values/ main.cpp
INPUT = interface/src/ interface/tests/ parser/src/ trace/src/ trace/src/values/ main.cpp
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
......
......@@ -76,7 +76,7 @@ public:
*/
std::string get_event_name() const;
/*! \fn check_definition
/*! \fn check_definition() const
* \brief Check if the definition stored is correct.
* \return true if the definition is correct.
*/
......
......@@ -31,20 +31,20 @@ public:
/*!
* \brief Constructor for the line
* \param A reference of the line to be copied
* \param l A reference of the line to be copied
*/
Line(Line &);
Line(Line &l);
/*!
* \brief Constructor for the line
* \param a filename
* \param filename : a filename
*/
Line(std::string &filename);
/*!
* \brief Constructor for the line
* \param : a filename
* \param filename : a filename
*/
Line(const char* filename);
......@@ -89,7 +89,13 @@ public:
*/
bool item (int i,std::string &e);
void print();
/*!
* \fn print()
* \brief print the line
* Useful for debug
*
*/
void print();
/*!
......
......@@ -11,6 +11,7 @@ class Parser{
public:
/*!
* \fn parse(std::string filename, Trace &trace) = 0
* \param : the name of the file to parse
* \param : the structure of data to fill
*/
......
......@@ -47,7 +47,7 @@ public:
/*!
* \fn get_definition(int i)
* \param : the integer matching the definition we want
* \param i : the integer matching the definition we want
* \return : the i-th definition
*/
Definition &get_definition(int i);
......@@ -60,7 +60,7 @@ public:
/*!
* \fn enter_definition(Line &line)
* \param : line
* \param line : line
*/
void enter_definition(Line &line);
......@@ -72,8 +72,8 @@ public:
/*!
* \fn add_field_to_definition(std::string& first_token, Line& line)
* \param : the name of the file to parse
* \param : the structure of data to fill
* \param first_token : the name of the file to parse
* \param line : the structure of data to fill
*/
void add_field_to_definition(std::string& first_token, Line& line);
......
......@@ -18,8 +18,8 @@ class ParserPaje {
public:
/*!
* \fn parse(std::string filename, Trace &trace)
* \param : the name of the file to parse
* \param : the structure of data to fill
* \param filename : the name of the file to parse
* \param trace : the structure of data to fill
*/
void parse(std::string filename, Trace &trace);
......
......@@ -53,7 +53,7 @@ public:
/*!
* \fn open()
* \fn open(const char *filename)
* \brief open a file
* \param valid filename
*/
......
......@@ -3,7 +3,7 @@
/*!
*
* \file color.hpp
* \file Color.hpp
* \author Johnny Jazeix
* \brief
* \date 2009 January 30th
......@@ -42,7 +42,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, Color &out)
* \brief Convert a string to a Color
* \param in String to convert
* \param out Color to be initialized
......@@ -53,7 +53,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
*
*/
std::string to_string() const;
......
......@@ -3,7 +3,7 @@
/*!
*
* \file date.hpp
* \file Date.hpp
* \author Clément Vuchener
* \brief
* \date 2009 January 30th
......@@ -37,7 +37,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, Date &out)
* \brief Convert a string to a Date
* \param in String to convert
* \param out Date to be initialized
......@@ -48,7 +48,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
*
*/
std::string to_string() const;
......
......@@ -3,7 +3,7 @@
/*!
*
* \file double.hpp
* \file Double.hpp
* \author Johnny Jazeix and CV
* \brief
* \date 2009 January 30th
......@@ -37,7 +37,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, Double &out)
* \brief Convert a string to a Double
* \param in String to convert
* \param out Double to be initialized
......@@ -48,7 +48,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
*
*/
std::string to_string() const;
......
......@@ -3,7 +3,7 @@
/*!
*
* \file hex.hpp
* \file Hex.hpp
* \author Clément Vuchener and JJ
* \brief
* \date 2009 January 30th
......@@ -42,7 +42,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, Hex &out)
* \brief Convert a string to a hex
* \param in String to convert
* \param out Hex to be initialized
......@@ -53,7 +53,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
*
*/
std::string to_string() const;
......
......@@ -3,7 +3,7 @@
/*!
*
* \file integer.hpp
* \file Integer.hpp
* \author Clément Vuchener
* \brief
* \date 2009 January 30th
......@@ -40,7 +40,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, Integer &out)
* \brief Convert a string to a Integer
* \param in String to convert
* \param out Integer to be initialized
......@@ -51,7 +51,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
*
*/
std::string to_string() const;
......
......@@ -2,7 +2,7 @@
#define NAME_HPP
/*!
*
* \file name.hpp
* \file Name.hpp
* \author Clément Vuchener
* \brief
* \date 2009 January 30th
......@@ -81,7 +81,7 @@ public:
/*!
*
* \fn to_string
* \fn to_string() const
* \return The name of the object, if it exists, the alias otherwise
*
*/
......@@ -89,7 +89,7 @@ public:
/*!
*
* \fn operator==
* \fn operator== (String &) const
* \brief Compare the string with the name or the alias
* \return true if the string equals the name or the alias
*
......
......@@ -3,7 +3,7 @@
/*!
*
* \file string.hpp
* \file String.hpp
* \author Johnny Jazeix and CV
* \brief
* \date 2009 January 30th
......@@ -35,7 +35,7 @@ public:
/*!
*
* \fn instantiate
* \fn instantiate(const std::string &in, String &out)
* \brief Convert a string to a String
* \param in string to convert
* \param out String to be initialized
......
......@@ -3,7 +3,7 @@
/*!
*
* \file value.hpp
* \file Value.hpp
* \author Clément Vuchener
* \brief Contains the definition of the class Value
* \date 2009 January 30th
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment