diff --git a/src/interface/interface_console.hpp b/src/interface/interface_console.hpp
index 974ebb09d18fb3574ef970a062d11d80025bc425..9f92d0235feaf0a0dc172822ea18d73d133a8946 100644
--- a/src/interface/interface_console.hpp
+++ b/src/interface/interface_console.hpp
@@ -155,7 +155,8 @@ public:
/*!
* \brief Launch an action according to the argument state value.
- * \arg state : an integer corresponding to a kind of action which must be executed.
+ * \param state An integer corresponding to a kind of action which must be executed.
+ * \param arg Contains necessary arguments needed for the action to launch.
*
* This functions triggers an action of ViTE according to its argument. state can takes some values :
* <ul><li><b>STATE_DISPLAY_HELP</b> -> this value means that the console interface must be displayed
@@ -250,9 +251,9 @@ protected:
/*!
* \brief Return the state of ViTE according to the arguments.
- * \arg argc : the number of parameters given when the program was called.
- * \arg argv : a set of strings which contains each parameter.
- * \return an integer corresponding to a command which will be processed by ViTE.
+ * \param argc The number of parameters given when the program was called.
+ * \param argv A set of strings which contains each parameter.
+ * \return An integer corresponding to a command which will be processed by ViTE.
*/
int get_state(int argc, char** argv);
@@ -260,9 +261,9 @@ protected:
/*!
* \brief Extracts the times of start and end in the string.
- * \arg name : the string where we extract times.
+ * \param name The string where we extract times.
*/
- void extract_times(const char *name);
+ void extract_times(const char* name);
/*!
* \brief Displays in the terminal the help text.
@@ -282,8 +283,8 @@ public:
/*!
* \brief The default constructor of the class.
- * \param argc : the number of parameters given when the program was called.
- * \param argv : a set of strings which contains each parameter.
+ * \param argc The number of parameters given when the program was called.
+ * \param argv A set of strings which contains each parameter.
*/
Interface_console(int argc, char** argv);
@@ -342,46 +343,51 @@ public:
**********************************/
/*!
- \arg string : the string to be displayed.
- \brief The function takes a string then displayed it into the terminal, then killed the application.
+ * \brief The function takes a string then displayed it into the terminal, then killed the application.
+ * \param string The string to be displayed.
*/
- void error(const std::string) const;
+ void error(const std::string string) const;
/*!
- \arg string : the string to be displayed.
\brief The function takes a string then displayed it into the terminal, then the program go on with an indeterminated behaviour.
+ \param string The string to be displayed.
*/
- void warning(const std::string) const;
+ void warning(const std::string string) const;
/*!
- \arg string : the string to be displayed.
- \brief The function takes a strings then displayed it into the terminal, then the program go on.
- */
- void information(const std::string) const;
+ * \brief The function takes a strings then displayed it into the terminal, then the program go on.
+ * \param string The string to be displayed.
+ */
+ void information(const std::string string) const;
/*!
- *\param string : the string to be displayed.
- *\brief Only use in graphic interface.
+ * \brief Only use in graphic interface.
+ * \param string The string to be displayed.
*/
- void selection_information(const std::string) const{
+ void selection_information(const std::string string) const{
}
/*!
*\brief Set the minimum for export
- *\param d : the double.
+ *\param d The double.
*/
void set_min_value_for_export(const double d);
/*!
*\brief Set the minimum for export
- *\param d : the double.
+ *\param d The double.
*/
void set_max_value_for_export(const double d);
public slots:
+
+ /*!
+ * \brief Update the progress bar value.
+ * \param loaded The percentage of trace which is already loaded.
+ */
void update_progress_bar(const int loaded);
};
diff --git a/src/interface/interface_graphic.hpp b/src/interface/interface_graphic.hpp
index 7a667ab2e2070ad389dd2d25db70c9669864613c..2b14ee8657a2d0c74fb5a224ebf11d4f87947913 100644
--- a/src/interface/interface_graphic.hpp
+++ b/src/interface/interface_graphic.hpp
@@ -65,8 +65,8 @@ class Interface_graphic : public QMainWindow, protected Ui::main_window, public
*/
QAction* _ui_toolbar_check;
- /*
- *\brief This variable contains the toolbar
+ /*!
+ * \brief This variable contains the toolbar
*/
QToolBar* _ui_toolbar;
@@ -207,9 +207,10 @@ public:
/*!
* \brief The default constructor
- * \param parent: the parent widget of the graphical interface. Should be ignored.
+ * \param core The Interface_console object which launch the Interface_graphic. It can be viewed as the application core.
+ * \param parent The parent widget of the graphical interface. Should be ignored.
*/
- Interface_graphic(Interface_console* core, QWidget *parent = 0);
+ Interface_graphic(Interface_console* core, QWidget* parent = 0);
/*!
@@ -226,22 +227,22 @@ public:
**********************************/
/*!
- * \param string : the string to be displayed.
- *\brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on with an indeterminated behaviour.
+ * \brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on with an indeterminated behaviour.
+ * \param string The string to be displayed.
*/
void error(const std::string string) const;
/*!
- *\param string : the string to be displayed.
- *\brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on with an indeterminated behaviour.
+ * \brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on with an indeterminated behaviour.
+ * \param string The string to be displayed.
*/
void warning(const std::string string) const;
/*!
- *\param string : the string to be displayed.
- *\brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on.
+ * \brief The function takes strings and/or numbers then displayed an info box containing it, then the program go on.
+ * \param string The string to be displayed.
*/
void information(const std::string string) const;
@@ -254,8 +255,8 @@ public:
**********************************/
/*!
- *\param string : the string to be displayed.
- *\brief The function takes strings and/or numbers then displayed it in the entity informative text area in the info window.
+ * \brief The function takes strings and/or numbers then displayed it in the entity informative text area in the info window.
+ * \param string The string to be displayed.
*/
void selection_information(const std::string string) const;
@@ -298,6 +299,7 @@ public:
* \brief Convert scroll units from real scroll bar unit to render area scroll unit.
* \param scroll_position The real value to convert.
* \param axe The choiced axe conversion ('x' for horizontal scrolling or 'y' for vertical scrolling)
+ * \return The converted value.
*/
Element_pos real_to_virtual_scroll_unit(int scroll_position, const char &axe);
@@ -305,6 +307,7 @@ public:
* \brief Convert scroll units from virtual render area scroll unit to real scroll bar unit.
* \param scroll_position The virtual value to convert.
* \param axe The choiced axe conversion ('x' for horizontal scrolling or 'y' for vertical scrolling)
+ * \return The converted value.
*/
int virtual_to_real_scroll_unit(Element_pos scroll_position, const char &axe);