Commit 428fb663 authored by Johnny Jazeix's avatar Johnny Jazeix

Doxyfile modified for taking in account all the headers files.

Adding comments in a lot of files for Doxygen.
End of the histogram statistic (else if you need some adjustement).

parent 6b098eef
......@@ -31,7 +31,7 @@ PROJECT_NAME = ViTE
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER = 0.3
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
......@@ -513,7 +513,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = src/interface/ src/message/ src/parser/ src/render/ src/trace/ src/trace/values/ src/main.cpp src/main_resource.hpp tests/interface tests/message tests/parser tests/trace src/Tools.cpp src/Tools.hpp
INPUT = src/interface/ src/message/ src/parser/ src/render/ src/trace/ src/trace/values/ src/trace/tree/ src/main.cpp src/main_resource.hpp src/statistics/ src/Tools.cpp src/Tools.hpp
# 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
......
......@@ -84,8 +84,8 @@ clean:
cleanall: clean
make -C \$(DOC)/user_manual cleanall
make -C \$(DOC)/technical_manual cleanall
@(cd bin/ && rm -rf vite)
@(cd ../documentation/ && \$(RM) html/ latex/)
@(cd bin/ && \$(RM) vite)
@(cd ../documentation/ && rm -rf html/ latex/)
distclean: cleanall
\$(RM) Makefile
......
......@@ -28,7 +28,7 @@ class Interface_console;
#include "resource.hpp"
#include "../Tools.hpp"
#include "../general/Tools.hpp"
#include "parsing_thread.hpp"
......
......@@ -171,6 +171,13 @@ public:
static void set(const std::string kind_of_error, const int priority);
/*!
* \fn set(const std::string kind_of_error, const unsigned int line_number, const int priority) static void
* \brief raise an error or a warning
* \param kind_of_error : content of error
* \param line_number : the line in the trace file where the error occurs.
* \param priority : _ERROR or _WARNING
*/
static void set(const std::string kind_of_error, const unsigned int line_number, const int priority);
/*!
* \fn set_and_print(const std::string kind_of_error, const int priority) static void
......
......@@ -33,6 +33,10 @@ public:
};
#endif
/*!
* \class Message
* \brief Contains routine for easily send messages of informations, warnings or errors to the user
*/
class Message: public std::stringstream {
private:
......
......@@ -3,7 +3,7 @@
*/
#ifndef RENDER_AREA_HPP
#ifndef RENDER_AREA_HPP
#define RENDER_AREA_HPP
......@@ -14,7 +14,7 @@ class Interface_console;
class Render_opengl;
/* Global informations */
#include "info/info.hpp"
#include "../info/info.hpp"
#include "resource.hpp"
......@@ -100,17 +100,17 @@ struct Selection_{
class Render_area : public QGLWidget/*, public Render*/
{
Q_OBJECT
protected:
/*!
* \brief Contains container text coordinates.
*/
std::list<Element_pos> _text_pos;
/*!
* \brief Contains container strings.
*/
......@@ -130,18 +130,18 @@ protected:
* \brief Contains the previous selection coordinates.
*/
std::stack<Selection_> _previous_selection;
/*!
* \brief Contains the OpenGL render instance.
*/
Render_opengl* _render_instance;
/*!
* \brief Contains the parent instance.
*/
Interface_console* _core;
/***********************************
*
......@@ -153,12 +153,12 @@ protected:
* \brief State when there is no file opened.
*/
static const int DRAWING_STATE_WAITING;
/*!
* \brief State when the application is drawing traces.
*/
static const int DRAWING_STATE_DRAWING;
/*!
* \brief Contains the kind of state for the render area (drawing, waiting, etc.).
......@@ -171,22 +171,22 @@ protected:
bool _mouse_pressed;
/*!
* \brief Used to store the mouse last x position.
* \brief Used to store the mouse last x position.
*/
int _mouse_x;
/*!
* \brief Used to store the mouse last y position.
* \brief Used to store the mouse last y position.
*/
int _mouse_y;
/*!
* \brief Used to store the mouse current x position.
* \brief Used to store the mouse current x position.
*/
int _new_mouse_x;
/*!
* \brief Used to store the mouse current y position.
* \brief Used to store the mouse current y position.
*/
int _new_mouse_y;
......@@ -204,7 +204,7 @@ protected:
* \brief Define the minimum width and height to draw the selection rectangle (avoid bas manipulations).
*/
Element_pos _minimum_distance_for_selection;
/*!
* \brief Define the scrolling factor when CTRL key is pressed.
*/
......@@ -214,18 +214,18 @@ protected:
* \brief Define the scrolling factor when CTRL key is pressed.
*/
static const int _ctrl_zoom_factor;
/***********************************
*
* The wait screen drawing.
*
**********************************/
/***********************************
* The wait list Attributes.
**********************************/
/*!
* \brief Rotation angle for the wait.
......@@ -241,14 +241,14 @@ protected:
* \brief Time in ms between two frames for the waiting screen.
*/
static const int DRAWING_TIMER_DEFAULT;
/*!
* \brief Wait animation seconds per frame.
*/
int _wait_spf;
/*!
* \brief Timer to animate the wait.
* \brief Timer to animate the wait.
*/
QTimer* _wait_timer;
......@@ -261,21 +261,21 @@ protected:
*
**********************************/
/***********************************
* The drawing list Attributes.
**********************************/
/*!
* \brief The waiting screen display list.
*/
*/
GLuint _wait_list;
/*!
* \brief The ruler display list.
*/
*/
GLuint _list_ruler;
/*!
......@@ -352,7 +352,7 @@ protected:
* \brief The y base of state area draw.
*/
Element_pos _state_y_min;
/*!
* \brief z position for the ruler.
*/
......@@ -369,12 +369,12 @@ protected:
Element_pos _z_ruler_under;
/*!
* \brief z position for containers.
* \brief z position for containers.
*/
Element_pos _z_container;
/*!
* \brief z position for objects under containers.
* \brief z position for objects under containers.
*/
Element_pos _z_container_under;
......@@ -417,7 +417,7 @@ protected:
* Highness of the ruler.
*/
Element_pos _ruler_y;
/*!
* Width of the ruler.
*/
......@@ -457,20 +457,20 @@ protected:
* \brief The y position of the vertical scroll bar.
*/
Element_pos _y_scroll_pos;
/***********************************
*
* Default QWidget functions.
*
**********************************/
/*!
* \brief This functions receives all mouse press events.
* \param event The event triggered by mouse.
*/
void mousePressEvent(QMouseEvent * event);
void mousePressEvent(QMouseEvent * event);
/*!
* \brief If user press, this functions receives all mouse move events until user release mouse.
......@@ -482,14 +482,14 @@ protected:
* \brief This functions receives all mouse release events.
* \param event The event triggered by mouse.
*/
void mouseReleaseEvent(QMouseEvent * event);
void mouseReleaseEvent(QMouseEvent * event);
/*!
* \brief This functions receives all mouse wheel events.
* \param event The event triggered by the mouse wheel.
*/
void wheelEvent(QWheelEvent * event);
/*!
* \brief This functions receives all keyboard events.
* \param event The event triggered by the keyboard event.
......@@ -502,7 +502,7 @@ protected:
*/
void keyReleaseEvent(QKeyEvent * event);
/***********************************
......@@ -510,7 +510,7 @@ protected:
* Render OpenGL drawing functions.
*
**********************************/
/*!
* \brief Display a wait on the screen if there is no file opened.
* \return Asset value of the wait.
......@@ -564,7 +564,7 @@ public:
* Scaling and scrolling functions.
*
**********************************/
/*!
* \brief Change the scale of state drawing.
......@@ -613,24 +613,24 @@ public:
* \param id The pre registered translation id.
*/
void registered_translate(int id);
/*!
* \brief Refresh scroll bar positions when shortcuts execute movements
* \param LENGTH_CHANGED If true the total length of the scroll bar will be updated.
*/
void refresh_scroll_bars(bool LENGTH_CHANGED = false);
/*!
* \brief Change the percentage taken by container display in the render area.
* \param view_size The new percentage (between 0 to 100).
*/
void change_scale_container_state(int view_size);/* temporary -> to change the size of container view */
/*!
* \brief This function updates the visible interval value (for export).
*/
void update_visible_interval_value();
/*!
* \brief Scale the current view to the zoom box shape.
* \param x_min the x minimum position.
......
......@@ -17,20 +17,20 @@ class Render_opengl_dl;
class Render_opengl_dl : public Render_opengl
{
Q_OBJECT
protected:
/***********************************
*
* The wait screen drawing.
*
**********************************/
/***********************************
* The wait list Attributes.
**********************************/
/*!
* \brief The wait GLu list.
*/
......@@ -107,7 +107,7 @@ public:
* \brief Closes the container display list.
*/
void end_draw_containers();
/*!
* \brief Creates and opens the display list for stater draws.
*/
......@@ -177,7 +177,7 @@ public:
* \brief Creates and opens the display list for counter draws.
*/
void start_draw_counter();
/*!
* \brief Draw a point of the counter.
* \param x x position of the point.
......@@ -186,7 +186,7 @@ public:
* Each time counter is increased, this function is called with the coordinates of the new point.
*/
void draw_counter(const Element_pos x, const Element_pos y);
/*!
* \brief Closes the counter display list.
*/
......@@ -197,7 +197,7 @@ public:
*/
void end_draw();
/***********************************
*
......@@ -213,7 +213,7 @@ public:
void display_container(Element_count container_begin, Element_count container_end);
/*!
* \brief Display on screen states between timer_begin and time_end,
* \brief Display on screen states between timer_begin and time_end,
* container_begin and container_end and with timer width between depth_begin and depth_end.
* \param time_begin floating point value : time of the first state.
* \param time_end floating point value : time of the last state.
......@@ -222,48 +222,48 @@ public:
* \param depth_begin floating point value : width of the narrowest state.
* \param depth_end floating point value : width of the widest state.
*/
void display_state(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end,
void display_state(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end,
Element_pos depth_begin, Element_pos depth_end);
/*!
* \brief Display on screen arrows between timer_begin and time_end,
* \brief Display on screen arrows between timer_begin and time_end,
* container_begin and container_end and with timer width between depth_begin and depth_end.
* \param time_begin floating point value : time of the smallest arrow time value.
* \param time_end floating point value : time of the higher arrow time value.
* \param container_begin integer value : id of the first container.
* \param container_end integer value : id of the last container.
* \param depth_begin floating point value : the narrowest difference between
* \param depth_begin floating point value : the narrowest difference between
* the beginning time and the ending time of the arrow.
* \param depth_end floating point value : width of the widest difference between
* the beginning time and the ending time of the arrow.
*/
void display_arrow(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end,
void display_arrow(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end,
Element_pos depth_begin, Element_pos depth_end);
/*!
* \brief Display on screen events between timer_begin and time_end,
* \brief Display on screen events between timer_begin and time_end,
* container_begin and container_end.
* \param time_begin floating point value : time of the first event.
* \param time_end floating point value : time of the last event.
* \param container_begin integer value : id of the first container.
* \param container_end integer value : id of the last container.
*/
void display_event(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end);
void display_event(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end);
/*!
* \brief Display on screen counters between timer_begin and time_end,
* \brief Display on screen counters between timer_begin and time_end,
* container_begin and container_end.
* \param time_begin floating point value : time of the smallest counter time value.
* \param time_end floating point value : time of the higher counter time value.
* \param container_begin integer value : id of the first container.
* \param container_end integer value : id of the last container.
*/
void display_counter(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end);
void display_counter(Element_pos time_begin, Element_pos time_end,
Element_count container_begin, Element_count container_end);
};
......@@ -287,7 +287,7 @@ public:
inline bool Render_opengl_dl::display_build(){
if (glIsList(_wait_list) == GL_TRUE){/* if the list exists */
glDeleteLists(_wait_list, 1);
_wait_list = 0;
......@@ -296,10 +296,10 @@ inline bool Render_opengl_dl::display_build(){
if (glIsList(_wait_list) == GL_TRUE){
*Message::get_instance() << "Cannot unbuild the waiting animation" << Message::endw;
}
if ((_wait_timer != NULL) && _wait_timer->isActive())/* if timer for the wait animation is running */
_wait_timer->stop();
return true;
}
......@@ -315,7 +315,7 @@ inline bool Render_opengl_dl::display_unbuild(){
if (!_wait_timer->isActive())/* if timer for the wait animation is not running */
_wait_timer->start(_wait_spf);
/*****************
*
......@@ -329,7 +329,7 @@ inline bool Render_opengl_dl::display_unbuild(){
*Message::get_instance() << "The wait draw was not released." << Message::endw;
return false;
}
/* if there is an error, do not display the wait an return immediatly */
if (glIsList(_wait_list) == GL_FALSE) {
*Message::get_instance() << "Cannot create the wait draw." << Message::endw;
......@@ -371,7 +371,7 @@ inline void Render_opengl_dl::start_draw_containers(){
_list_containers = glGenLists(1);/* create the list */
if (_list_containers == 0) {
// _parent->warning("Error when creating list");
}
......@@ -396,13 +396,13 @@ inline void Render_opengl_dl::draw_container(const Element_pos x, const Element_
if ((x+w)>_container_x_max)
_container_x_max = x+w;
if ((y+h)>_container_y_max)
_container_y_max = y+h;
if (_container_x_min > x)
_container_x_min = x;
if (_container_y_min > y)
_container_y_min = y;
......@@ -410,9 +410,9 @@ inline void Render_opengl_dl::draw_container(const Element_pos x, const Element_
#ifdef DEBUG_MODE_RENDER_AREA
std::cerr << __FILE__ << " l." << __LINE__ << ":" << std::endl;
std::cerr << __FILE__ << " l." << __LINE__ << ":" << std::endl;
std::cerr < "Container drawing:" << std::endl;
std::cerr << "x: " << x << " y: " << y << " w: " << w << " h: " << h << " xmax-xmin: " << _container_x_max << " - " << _container_x_min << " ymax-ymin: " << _container_y_max << " - " << _container_y_min << std::endl;
std::cerr << "x: " << x << " y: " << y << " w: " << w << " h: " << h << " xmax-xmin: " << _container_x_max << " - " << _container_x_min << " ymax-ymin: " << _container_y_max << " - " << _container_y_min << std::endl;
#endif
......@@ -420,7 +420,7 @@ inline void Render_opengl_dl::draw_container(const Element_pos x, const Element_
inline void Render_opengl_dl::draw_container_text(const Element_pos x, const Element_pos y, const std::string value){
_text_pos.push_back(x);
_text_pos.push_back(x);
_text_pos.push_back(y);
_text_value.push_back(value);
......@@ -439,22 +439,22 @@ inline void Render_opengl_dl::start_draw_states(){
_list_states = glGenLists(1);/* create the list */
if (_list_states == 0) {
// _parent->warning("Error when creating list");
}
glNewList(_list_states, GL_COMPILE);/* open the list */
}
inline void Render_opengl_dl::draw_state(const Element_pos start, const Element_pos end, const Element_pos base, const Element_pos height, const Element_col r, const Element_col g, const Element_col b) {
#ifdef DEBUG_MODE_RENDER_AREA
std::cerr << __FILE__ << " l." << __LINE__ << ":" << std::endl;
std::cerr << "States position (for drawing): (x = " << start << ", y = " << base << ", w = " << end-start << ", h = " << height << ")" << std::endl << std::endl;
std::cerr << __FILE__ << " l." << __LINE__ << ":" << std::endl;
std::cerr << "States position (for drawing): (x = " << start << ", y = " << base << ", w = " << end-start << ", h = " << height << ")" << std::endl << std::endl;
#endif
......@@ -462,7 +462,7 @@ inline void Render_opengl_dl::draw_state(const Element_pos start, const Element_
// if (start==end)
/* std::cout << std::setprecision(15) << std::endl;
std::cerr << "Start "<< start << " end " << end << std::endl;*/
glBegin(GL_QUADS);/* create a quads */
{
glColor3d(r, g, b);glVertex2d(start, base);
......@@ -474,13 +474,13 @@ inline void Render_opengl_dl::draw_state(const Element_pos start, const Element_
if (end > _state_x_max)
_state_x_max = end;
if ((base+height) > _state_y_max)
_state_y_max = base+height;
if (_state_x_min > start)
_state_x_min = start;
if (_state_y_min > base)
_state_y_min = base;
}
......@@ -524,10 +524,10 @@ inline void Render_opengl_dl::draw_stored_arrows(std::vector<Arrow_> &arrows){