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 ...@@ -31,7 +31,7 @@ PROJECT_NAME = ViTE
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # 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) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
...@@ -513,7 +513,7 @@ WARN_LOGFILE = ...@@ -513,7 +513,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # 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 # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
......
...@@ -84,8 +84,8 @@ clean: ...@@ -84,8 +84,8 @@ clean:
cleanall: clean cleanall: clean
make -C \$(DOC)/user_manual cleanall make -C \$(DOC)/user_manual cleanall
make -C \$(DOC)/technical_manual cleanall make -C \$(DOC)/technical_manual cleanall
@(cd bin/ && rm -rf vite) @(cd bin/ && \$(RM) vite)
@(cd ../documentation/ && \$(RM) html/ latex/) @(cd ../documentation/ && rm -rf html/ latex/)
distclean: cleanall distclean: cleanall
\$(RM) Makefile \$(RM) Makefile
......
...@@ -28,7 +28,7 @@ class Interface_console; ...@@ -28,7 +28,7 @@ class Interface_console;
#include "resource.hpp" #include "resource.hpp"
#include "../Tools.hpp" #include "../general/Tools.hpp"
#include "parsing_thread.hpp" #include "parsing_thread.hpp"
......
...@@ -171,6 +171,13 @@ public: ...@@ -171,6 +171,13 @@ public:
static void set(const std::string kind_of_error, const int priority); 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); 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 * \fn set_and_print(const std::string kind_of_error, const int priority) static void
......
...@@ -33,6 +33,10 @@ public: ...@@ -33,6 +33,10 @@ public:
}; };
#endif #endif
/*!
* \class Message
* \brief Contains routine for easily send messages of informations, warnings or errors to the user
*/
class Message: public std::stringstream { class Message: public std::stringstream {
private: private:
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
*/ */
#ifndef RENDER_AREA_HPP #ifndef RENDER_AREA_HPP
#define RENDER_AREA_HPP #define RENDER_AREA_HPP
...@@ -14,7 +14,7 @@ class Interface_console; ...@@ -14,7 +14,7 @@ class Interface_console;
class Render_opengl; class Render_opengl;
/* Global informations */ /* Global informations */
#include "info/info.hpp" #include "../info/info.hpp"
#include "resource.hpp" #include "resource.hpp"
...@@ -100,17 +100,17 @@ struct Selection_{ ...@@ -100,17 +100,17 @@ struct Selection_{
class Render_area : public QGLWidget/*, public Render*/ class Render_area : public QGLWidget/*, public Render*/
{ {
Q_OBJECT Q_OBJECT
protected: protected:
/*! /*!
* \brief Contains container text coordinates. * \brief Contains container text coordinates.
*/ */
std::list<Element_pos> _text_pos; std::list<Element_pos> _text_pos;
/*! /*!
* \brief Contains container strings. * \brief Contains container strings.
*/ */
...@@ -130,18 +130,18 @@ protected: ...@@ -130,18 +130,18 @@ protected:
* \brief Contains the previous selection coordinates. * \brief Contains the previous selection coordinates.
*/ */
std::stack<Selection_> _previous_selection; std::stack<Selection_> _previous_selection;
/*! /*!
* \brief Contains the OpenGL render instance. * \brief Contains the OpenGL render instance.
*/ */
Render_opengl* _render_instance; Render_opengl* _render_instance;
/*! /*!
* \brief Contains the parent instance. * \brief Contains the parent instance.
*/ */
Interface_console* _core; Interface_console* _core;
/*********************************** /***********************************
* *
...@@ -153,12 +153,12 @@ protected: ...@@ -153,12 +153,12 @@ protected:
* \brief State when there is no file opened. * \brief State when there is no file opened.
*/ */
static const int DRAWING_STATE_WAITING; static const int DRAWING_STATE_WAITING;
/*! /*!
* \brief State when the application is drawing traces. * \brief State when the application is drawing traces.
*/ */
static const int DRAWING_STATE_DRAWING; static const int DRAWING_STATE_DRAWING;
/*! /*!
* \brief Contains the kind of state for the render area (drawing, waiting, etc.). * \brief Contains the kind of state for the render area (drawing, waiting, etc.).
...@@ -171,22 +171,22 @@ protected: ...@@ -171,22 +171,22 @@ protected:
bool _mouse_pressed; bool _mouse_pressed;
/*! /*!
* \brief Used to store the mouse last x position. * \brief Used to store the mouse last x position.
*/ */
int _mouse_x; int _mouse_x;
/*! /*!
* \brief Used to store the mouse last y position. * \brief Used to store the mouse last y position.
*/ */
int _mouse_y; 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; 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; int _new_mouse_y;
...@@ -204,7 +204,7 @@ protected: ...@@ -204,7 +204,7 @@ protected:
* \brief Define the minimum width and height to draw the selection rectangle (avoid bas manipulations). * \brief Define the minimum width and height to draw the selection rectangle (avoid bas manipulations).
*/ */
Element_pos _minimum_distance_for_selection; Element_pos _minimum_distance_for_selection;
/*! /*!
* \brief Define the scrolling factor when CTRL key is pressed. * \brief Define the scrolling factor when CTRL key is pressed.
*/ */
...@@ -214,18 +214,18 @@ protected: ...@@ -214,18 +214,18 @@ protected:
* \brief Define the scrolling factor when CTRL key is pressed. * \brief Define the scrolling factor when CTRL key is pressed.
*/ */
static const int _ctrl_zoom_factor; static const int _ctrl_zoom_factor;
/*********************************** /***********************************
* *
* The wait screen drawing. * The wait screen drawing.
* *
**********************************/ **********************************/
/*********************************** /***********************************
* The wait list Attributes. * The wait list Attributes.
**********************************/ **********************************/
/*! /*!
* \brief Rotation angle for the wait. * \brief Rotation angle for the wait.
...@@ -241,14 +241,14 @@ protected: ...@@ -241,14 +241,14 @@ protected:
* \brief Time in ms between two frames for the waiting screen. * \brief Time in ms between two frames for the waiting screen.
*/ */
static const int DRAWING_TIMER_DEFAULT; static const int DRAWING_TIMER_DEFAULT;
/*! /*!
* \brief Wait animation seconds per frame. * \brief Wait animation seconds per frame.
*/ */
int _wait_spf; int _wait_spf;
/*! /*!
* \brief Timer to animate the wait. * \brief Timer to animate the wait.
*/ */
QTimer* _wait_timer; QTimer* _wait_timer;
...@@ -261,21 +261,21 @@ protected: ...@@ -261,21 +261,21 @@ protected:
* *
**********************************/ **********************************/
/*********************************** /***********************************
* The drawing list Attributes. * The drawing list Attributes.
**********************************/ **********************************/
/*! /*!
* \brief The waiting screen display list. * \brief The waiting screen display list.
*/ */
GLuint _wait_list; GLuint _wait_list;
/*! /*!
* \brief The ruler display list. * \brief The ruler display list.
*/ */
GLuint _list_ruler; GLuint _list_ruler;
/*! /*!
...@@ -352,7 +352,7 @@ protected: ...@@ -352,7 +352,7 @@ protected:
* \brief The y base of state area draw. * \brief The y base of state area draw.
*/ */
Element_pos _state_y_min; Element_pos _state_y_min;
/*! /*!
* \brief z position for the ruler. * \brief z position for the ruler.
*/ */
...@@ -369,12 +369,12 @@ protected: ...@@ -369,12 +369,12 @@ protected:
Element_pos _z_ruler_under; Element_pos _z_ruler_under;
/*! /*!
* \brief z position for containers. * \brief z position for containers.
*/ */
Element_pos _z_container; Element_pos _z_container;
/*! /*!
* \brief z position for objects under containers. * \brief z position for objects under containers.
*/ */
Element_pos _z_container_under; Element_pos _z_container_under;
...@@ -417,7 +417,7 @@ protected: ...@@ -417,7 +417,7 @@ protected:
* Highness of the ruler. * Highness of the ruler.
*/ */
Element_pos _ruler_y; Element_pos _ruler_y;
/*! /*!
* Width of the ruler. * Width of the ruler.
*/ */
...@@ -457,20 +457,20 @@ protected: ...@@ -457,20 +457,20 @@ protected:
* \brief The y position of the vertical scroll bar. * \brief The y position of the vertical scroll bar.
*/ */
Element_pos _y_scroll_pos; Element_pos _y_scroll_pos;
/*********************************** /***********************************
* *
* Default QWidget functions. * Default QWidget functions.
* *
**********************************/ **********************************/
/*! /*!
* \brief This functions receives all mouse press events. * \brief This functions receives all mouse press events.
* \param event The event triggered by mouse. * \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. * \brief If user press, this functions receives all mouse move events until user release mouse.
...@@ -482,14 +482,14 @@ protected: ...@@ -482,14 +482,14 @@ protected:
* \brief This functions receives all mouse release events. * \brief This functions receives all mouse release events.
* \param event The event triggered by mouse. * \param event The event triggered by mouse.
*/ */
void mouseReleaseEvent(QMouseEvent * event); void mouseReleaseEvent(QMouseEvent * event);
/*! /*!
* \brief This functions receives all mouse wheel events. * \brief This functions receives all mouse wheel events.
* \param event The event triggered by the mouse wheel. * \param event The event triggered by the mouse wheel.
*/ */
void wheelEvent(QWheelEvent * event); void wheelEvent(QWheelEvent * event);
/*! /*!
* \brief This functions receives all keyboard events. * \brief This functions receives all keyboard events.
* \param event The event triggered by the keyboard event. * \param event The event triggered by the keyboard event.
...@@ -502,7 +502,7 @@ protected: ...@@ -502,7 +502,7 @@ protected:
*/ */
void keyReleaseEvent(QKeyEvent * event); void keyReleaseEvent(QKeyEvent * event);
/*********************************** /***********************************
...@@ -510,7 +510,7 @@ protected: ...@@ -510,7 +510,7 @@ protected:
* Render OpenGL drawing functions. * Render OpenGL drawing functions.
* *
**********************************/ **********************************/
/*! /*!
* \brief Display a wait on the screen if there is no file opened. * \brief Display a wait on the screen if there is no file opened.
* \return Asset value of the wait. * \return Asset value of the wait.
...@@ -564,7 +564,7 @@ public: ...@@ -564,7 +564,7 @@ public:
* Scaling and scrolling functions. * Scaling and scrolling functions.
* *
**********************************/ **********************************/
/*! /*!
* \brief Change the scale of state drawing. * \brief Change the scale of state drawing.
...@@ -613,24 +613,24 @@ public: ...@@ -613,24 +613,24 @@ public:
* \param id The pre registered translation id. * \param id The pre registered translation id.
*/ */
void registered_translate(int id); void registered_translate(int id);
/*! /*!
* \brief Refresh scroll bar positions when shortcuts execute movements * \brief Refresh scroll bar positions when shortcuts execute movements
* \param LENGTH_CHANGED If true the total length of the scroll bar will be updated. * \param LENGTH_CHANGED If true the total length of the scroll bar will be updated.
*/ */
void refresh_scroll_bars(bool LENGTH_CHANGED = false); void refresh_scroll_bars(bool LENGTH_CHANGED = false);
/*! /*!
* \brief Change the percentage taken by container display in the render area. * \brief Change the percentage taken by container display in the render area.
* \param view_size The new percentage (between 0 to 100). * \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 */ 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). * \brief This function updates the visible interval value (for export).
*/ */
void update_visible_interval_value(); void update_visible_interval_value();
/*! /*!
* \brief Scale the current view to the zoom box shape. * \brief Scale the current view to the zoom box shape.
* \param x_min the x minimum position. * \param x_min the x minimum position.
......
This diff is collapsed.
...@@ -14,6 +14,8 @@ using namespace std; ...@@ -14,6 +14,8 @@ using namespace std;
Render_stats_opengl::Render_stats_opengl(QWidget *parent) : QGLWidget(parent){ Render_stats_opengl::Render_stats_opengl(QWidget *parent) : QGLWidget(parent){
_translated_y = 0; _translated_y = 0;
_translated_x = 0; _translated_x = 0;
_render_height = height();
_render_width = width();
} }
Render_stats_opengl::~Render_stats_opengl(){ Render_stats_opengl::~Render_stats_opengl(){
...@@ -88,13 +90,22 @@ void Render_stats_opengl::paintGL(){ ...@@ -88,13 +90,22 @@ void Render_stats_opengl::paintGL(){
} }
void Render_stats_opengl::translate_y(int value) { void Render_stats_opengl::translate_y(int value) {
_translated_y = (double)value/100.0*_render_height; if(value == 0) {
//cout << "h :" << _render_height << endl; _translated_y = 0;
}
else {
_translated_y = (double)(value+1)/100.0*_render_height;
}
updateGL(); updateGL();
} }
void Render_stats_opengl::translate_x(int value) { void Render_stats_opengl::translate_x(int value) {
_translated_x = (double)value/100.0*_render_width; if(value == 0) {
_translated_x = 0;
}
else {
_translated_x = (double)(value+1)/100.0*_render_width;
}
//cout << "w :" << _render_width << endl; //cout << "w :" << _render_width << endl;
updateGL(); updateGL();
} }
......
...@@ -75,6 +75,7 @@ public: ...@@ -75,6 +75,7 @@ public:
void start_draw(); void start_draw();
/*! /*!
* \fn draw_text(const Element_pos x, const Element_pos y, const std::string value)
* \brief Draw the text of a container. * \brief Draw the text of a container.
* \param x the x position of the text. * \param x the x position of the text.
* \param y the y position of the text. * \param y the y position of the text.
...@@ -83,21 +84,31 @@ public: ...@@ -83,21 +84,31 @@ public:
void draw_text(const Element_pos x, const Element_pos y, const std::string value); void draw_text(const Element_pos x, const Element_pos y, const std::string value);
/*! /*!
* \fn draw_horizontal_line(const Element_pos x, const Element_pos y, const Element_pos size_x)
* \brief Draw a line. * \brief Draw a line.
* \param x the x position of the text. * \param x the x position of the origin.
* \param y the y position of the text. * \param y the y position of the origin.
* \param value the string value of the text. * \param size_x the length of the line.
*/ */
void draw_horizontal_line(const Element_pos x, const Element_pos y, const Element_pos size_x); void draw_horizontal_line(const Element_pos x, const Element_pos y, const Element_pos size_x);
/*! /*!
* \fn draw_vertical_line(const Element_pos x, const Element_pos y, const Element_pos size_y)
* \brief Draw a line. * \brief Draw a line.
* \param x the x position of the text. * \param x the x position of the origin.
* \param y the y position of the text. * \param y the y position of the origin.
* \param value the string value of the text. * \param size_y the length of the line.
*/ */
void draw_vertical_line(const Element_pos x, const Element_pos y, const Element_pos size_x); void draw_vertical_line(const Element_pos x, const Element_pos y, const Element_pos size_y);
/*!
* \fn draw_axis(const Element_pos x, const Element_pos y, const Element_pos size_x, const Element_pos size_y)
* \brief Draw axis.
* \param x the x position of the origin.
* \param y the y position of the origin.
* \param size_x the length for the horizontal axis.
* \param size_y the length for the vertical axis.
*/
void draw_axis(const Element_pos x, const Element_pos y, const Element_pos size_x, const Element_pos size_y); void draw_axis(const Element_pos x, const Element_pos y, const Element_pos size_x, const Element_pos size_y);
/*! /*!
* \brief Draw a rectangle. * \brief Draw a rectangle.
...@@ -111,7 +122,17 @@ public: ...@@ -111,7 +122,17 @@ public:
*/ */
void end_draw(); void end_draw();
/*!
* \fn translate_y(int value)
* \brief Translate the window on the vertical axis.
* \param value the new value of the scroll bar.
*/
void translate_y(int value); void translate_y(int value);
/*!
* \fn translate_x(int value)
* \brief Translate the window on the horizontal axis.
* \param value the new value of the scroll bar.
*/
void translate_x(int value); void translate_x(int value);
/*! /*!
......
...@@ -28,7 +28,6 @@ macx { ...@@ -28,7 +28,6 @@ macx {
# Input # Input
HEADERS += message/Message.hpp \ HEADERS += message/Message.hpp \
message/Errors.hpp \ message/Errors.hpp \
Tools.hpp \
main_resource.hpp \ main_resource.hpp \
# Info header # Info header
info/info.hpp \ info/info.hpp \
...@@ -87,6 +86,8 @@ HEADERS += message/Message.hpp \ ...@@ -87,6 +86,8 @@ HEADERS += message/Message.hpp \
trace/tree/BinaryTree.hpp \ trace/tree/BinaryTree.hpp \
trace/tree/Node.hpp \ trace/tree/Node.hpp \
trace/tree/Interval.hpp \ trace/tree/Interval.hpp \
# General headers
general/Tools.hpp \
# Statistics headers # Statistics headers
statistics/Stats_window.hpp \ statistics/Stats_window.hpp \
statistics/Statistic.hpp \ statistics/Statistic.hpp \
...@@ -95,7 +96,6 @@ HEADERS += message/Message.hpp \ ...@@ -95,7 +96,6 @@ HEADERS += message/Message.hpp \
FORMS += interface/info_window.ui interface/main_window.ui interface/option_export_window.ui interface/stats_viewer.ui FORMS += interface/info_window.ui interface/main_window.ui interface/option_export_window.ui interface/stats_viewer.ui
SOURCES += message/Message.cpp \ SOURCES += message/Message.cpp \
message/Errors.cpp \ message/Errors.cpp \
Tools.cpp \
main.cpp \ main.cpp \
# Info code file # Info code file
info/info.cpp \ info/info.cpp \
...@@ -141,6 +141,8 @@ SOURCES += message/Message.cpp \ ...@@ -141,6 +141,8 @@ SOURCES += message/Message.cpp \
trace/values/Name.cpp \ trace/values/Name.cpp \
trace/values/String.cpp \ trace/values/String.cpp \
trace/tree/Interval.cpp \ trace/tree/Interval.cpp \
# General code files
general/Tools.cpp \
# Statistics code files # Statistics code files
statistics/Stats_window.cpp \ statistics/Stats_window.cpp \
statistics/Statistic.cpp statistics/Statistic.cpp
......
/*! /*!
*\file DrawStats.hpp *\file DrawDiagram.hpp
*/ */