From 12e06f3aa400c75e13a3c1685bdccf3691cb4039 Mon Sep 17 00:00:00 2001 From: Jean Sirmai Date: Tue, 22 Oct 2024 23:58:04 +0200 Subject: [PATCH] doxygen compatible (cleaned) but severe modif in graphics doc (init, draw, grid) --- doc/docbook/annotated.xml | 8 +- doc/docbook/d0/d0b/structelem.xml | 4 +- doc/docbook/d1/d04/structdblist.xml | 4 +- doc/docbook/d1/d0c/util_2tree_8c.xml | 6 +- doc/docbook/d2/d02/grid_8c.xml | 78 +++-- doc/docbook/d5/d0f/tests_8c.xml | 4 +- doc/docbook/d6/d09/draw_8c.xml | 48 ++- doc/docbook/d7/d04/graphics_8h.xml | 443 ++----------------------- doc/docbook/d7/d09/list__2x2_8c.xml | 4 +- doc/docbook/d8/d00/init_8c.xml | 54 +-- doc/docbook/d8/d01/strings__op_8c.xml | 4 +- doc/docbook/d8/d0c/util_8h.xml | 177 +--------- doc/docbook/da/d03/structpile.xml | 4 +- doc/docbook/da/d0c/gl_8c.xml | 18 +- doc/docbook/db/d02/designer_8c.xml | 10 +- doc/docbook/db/d07/parse_8c.xml | 4 +- doc/docbook/db/d08/pile_8c.xml | 4 +- doc/docbook/dc/d0e/sorted__list_8c.xml | 4 +- doc/docbook/df/d05/structslist.xml | 4 +- doc/docbook/df/d0a/io_8c.xml | 4 +- doc/rtfm/man3/dblist.3 | 4 +- doc/rtfm/man3/designer.c.3 | 10 +- doc/rtfm/man3/draw.c.3 | 36 +- doc/rtfm/man3/elem.3 | 4 +- doc/rtfm/man3/gl.c.3 | 16 +- doc/rtfm/man3/graphics.h.3 | 222 ++----------- doc/rtfm/man3/grid.c.3 | 39 ++- doc/rtfm/man3/init.c.3 | 29 +- doc/rtfm/man3/io.c.3 | 4 +- doc/rtfm/man3/list_2x2.c.3 | 4 +- doc/rtfm/man3/parse.c.3 | 4 +- doc/rtfm/man3/pile.3 | 4 +- doc/rtfm/man3/pile.c.3 | 4 +- doc/rtfm/man3/slist.3 | 4 +- doc/rtfm/man3/sorted_list.c.3 | 4 +- doc/rtfm/man3/strings_op.c.3 | 4 +- doc/rtfm/man3/tests.c.3 | 4 +- doc/rtfm/man3/util.h.3 | 94 +----- include/graphics.h | 188 +---------- include/util.h | 67 +--- src/graphics/draw.c | 49 +-- src/graphics/grid.c | 135 ++++---- src/graphics/init.c | 46 ++- src/util/draw/gl.c | 21 +- src/util/io.c | 2 +- src/util/list_2x2.c | 2 +- src/util/parse.c | 2 +- src/util/pile.c | 2 +- src/util/sorted_list.c | 2 +- src/util/strings_op.c | 2 +- src/util/tests.c | 2 +- src/util/tree.c | 2 +- src/widget/main_window/designer.c | 8 +- 53 files changed, 469 insertions(+), 1437 deletions(-) diff --git a/doc/docbook/annotated.xml b/doc/docbook/annotated.xml index 2be57f4..de4673c 100644 --- a/doc/docbook/annotated.xml +++ b/doc/docbook/annotated.xml @@ -4,9 +4,9 @@ Here are the classes, structs, unions and interfaces with brief descriptions:arrow_t Defines an arrow address dblist -Phantom documentation used to test the functioning of doxygen +Required to init the empty list elem -Phantom documentation used to test the functioning of doxygen +Simplest element of a double-chained list fsm_struct_journal Required to initialise a double-chained list fsm_struct_journal_unit @@ -20,9 +20,9 @@ Here are the classes, structs, unions and interfaces with brief descriptions:
  • graphics_stack_t Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas pile -Phantom documentation used to test the functioning of doxygen +Phantom documentation preferencesslist -Phantom documentation used to test the functioning of doxygen +Phantom documentation Stack Phantom documentation stack_index_t diff --git a/doc/docbook/d0/d0b/structelem.xml b/doc/docbook/d0/d0b/structelem.xml index c871b97..9b66512 100644 --- a/doc/docbook/d0/d0b/structelem.xml +++ b/doc/docbook/d0/d0b/structelem.xml @@ -4,7 +4,7 @@ elem -phantom documentation used to test the functioning of doxygen +simplest element of a double-chained list @@ -30,7 +30,7 @@
    Detailed Description -phantom documentation used to test the functioning of doxygen +simplest element of a double-chained list The documentation for this struct was generated from the following file: include/util.h
    diff --git a/doc/docbook/d1/d04/structdblist.xml b/doc/docbook/d1/d04/structdblist.xml index e7ff290..a8839d3 100644 --- a/doc/docbook/d1/d04/structdblist.xml +++ b/doc/docbook/d1/d04/structdblist.xml @@ -4,7 +4,7 @@ dblist -phantom documentation used to test the functioning of doxygen +required to init the empty list @@ -26,7 +26,7 @@
    Detailed Description -phantom documentation used to test the functioning of doxygen +required to init the empty list The documentation for this struct was generated from the following file: include/util.h
    diff --git a/doc/docbook/d1/d0c/util_2tree_8c.xml b/doc/docbook/d1/d0c/util_2tree_8c.xml index 0f69f1c..c32856c 100644 --- a/doc/docbook/d1/d0c/util_2tree_8c.xml +++ b/doc/docbook/d1/d0c/util_2tree_8c.xml @@ -4,7 +4,7 @@ src/util/tree.c -Gem-graph-client. +tree functions #include "../../include/fsm.h"#include "../../include/signal.h"#include "../../include/widget.h" @@ -30,9 +30,7 @@
    Detailed Description -Gem-graph-client. - -Widget tree functions. +tree functions This file is part of Gem-graph.
    diff --git a/doc/docbook/d2/d02/grid_8c.xml b/doc/docbook/d2/d02/grid_8c.xml index ab60349..a29617a 100644 --- a/doc/docbook/d2/d02/grid_8c.xml +++ b/doc/docbook/d2/d02/grid_8c.xml @@ -10,21 +10,19 @@ #include "../../include/graphics.h" Functions - int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z) + int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z) phantom documentation used to test the functioning of doxygen - int graphics_draw_space_ridges_lines (const int stack_id) + int graphics_draw_space_ridges_lines (const int graphics_stack_id) phantom documentation used to test the functioning of doxygen - long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z) + long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z) -phantom documentation used to test the functioning of doxygen +Writes grid lines on space faces. - long graphics_draw_grids_on_space_faces_lines (const int stack_id, long offset_vertex, long x, long y, long z) - -phantom documentation used to test the functioning of doxygen + long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) @@ -37,15 +35,11 @@
    Function Documentation -
    +
    graphics_draw_grids_on_space_faces_lines() graphics_draw_grids_on_space_faces_linesgrid.c grid.cgraphics_draw_grids_on_space_faces_lines -long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) - -phantom documentation used to test the functioning of doxygen - - +long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) @@ -90,33 +84,59 @@ Parameters
    -
    +
    graphics_draw_grids_on_space_faces_vertex() graphics_draw_grids_on_space_faces_vertexgrid.c grid.cgraphics_draw_grids_on_space_faces_vertex -long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z) - -phantom documentation used to test the functioning of doxygen - +long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z) Writes grid lines on space faces. -
    -
    - graphics_draw_space_ridges_lines() -graphics_draw_space_ridges_linesgrid.c -grid.cgraphics_draw_space_ridges_lines -int graphics_draw_space_ridges_lines (const int stack_id) - -phantom documentation used to test the functioning of doxygen -draw_space_ridges_lines + + + +Parameters + + + + + + + +graphics_stack_id + + + + +x + + + + +y + + + + +z + + + +
    +     +     + Returns + +l + +
    -
    +
    graphics_draw_space_ridges_vertex() graphics_draw_space_ridges_vertexgrid.c grid.cgraphics_draw_space_ridges_vertex -int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z) +int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z) phantom documentation used to test the functioning of doxygen diff --git a/doc/docbook/d5/d0f/tests_8c.xml b/doc/docbook/d5/d0f/tests_8c.xml index 257626a..c0b5a3a 100644 --- a/doc/docbook/d5/d0f/tests_8c.xml +++ b/doc/docbook/d5/d0f/tests_8c.xml @@ -4,7 +4,7 @@ src/util/tests.c -Gem-graph-client. +use to check utilities #include "../../include/util.h"#include "../../include/base.h"#include "../../include/fsm.h" @@ -31,7 +31,7 @@
    Detailed Description -Gem-graph-client. +use to check utilities This file is part of Gem-graph. It only groups various tests.
    diff --git a/doc/docbook/d6/d09/draw_8c.xml b/doc/docbook/d6/d09/draw_8c.xml index 151056a..1d7d95b 100644 --- a/doc/docbook/d6/d09/draw_8c.xml +++ b/doc/docbook/d6/d09/draw_8c.xml @@ -10,23 +10,23 @@ #include <cglm/cglm.h>#include "../../include/base.h"#include "../../include/graphics.h" Functions - void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z) + void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z) Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. - void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b) + void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b) -Writes values to describe a color (r,g,b) into the color buffer. +Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. - void graphics_draw_line (const int stack_id, GLuint a, GLuint b) + void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b) Writes values to describe a line from a to b into the line buffer. - void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c) + void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c) Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. - void graphics_draw (const int stack_id) + void graphics_draw (const int graphics_stack_id) Draws the current buffer to a gl_area. @@ -41,11 +41,11 @@
    Function Documentation -
    +
    graphics_draw() graphics_drawdraw.c draw.cgraphics_draw -void graphics_draw (const int stack_id) +void graphics_draw (const int graphics_stack_id) Draws the current buffer to a gl_area. @@ -61,7 +61,7 @@ Parameters -stack_id +graphics_stack_id gl_area, ptr to the gl_area widget @@ -72,17 +72,15 @@ Parameters
    -
    +
    graphics_draw_color() graphics_draw_colordraw.c draw.cgraphics_draw_color -void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b) +void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b) -Writes values to describe a color (r,g,b) into the color buffer. +Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. -Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. - @@ -94,7 +92,7 @@ Parameters -stack_id +graphics_stack_id @@ -120,11 +118,11 @@ Parameters
    -
    +
    graphics_draw_line() graphics_draw_linedraw.c draw.cgraphics_draw_line -void graphics_draw_line (const int stack_id, GLuint a, GLuint b) +void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b) Writes values to describe a line from a to b into the line buffer. @@ -140,7 +138,7 @@ Parameters -stack_id +graphics_stack_id @@ -161,11 +159,11 @@ Parameters
    -
    +
    graphics_draw_plan() graphics_draw_plandraw.c draw.cgraphics_draw_plan -void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c) +void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c) Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. @@ -181,7 +179,7 @@ Parameters -stack_id +graphics_stack_id @@ -207,17 +205,15 @@ Parameters
    -
    +
    graphics_draw_vertex() graphics_draw_vertexdraw.c draw.cgraphics_draw_vertex -void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z) +void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z) Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. -Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. - @@ -229,7 +225,7 @@ Parameters -stack_id +graphics_stack_id diff --git a/doc/docbook/d7/d04/graphics_8h.xml b/doc/docbook/d7/d04/graphics_8h.xml index 92c9c98..18de17f 100644 --- a/doc/docbook/d7/d04/graphics_8h.xml +++ b/doc/docbook/d7/d04/graphics_8h.xml @@ -40,14 +40,6 @@ Functions - bool graphics_render_stack (GtkWidget *container_widget) - -Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. - - bool graphics_setup_glarea (int target_mode, GtkWidget *target_widget) - -phantom documentation - int graphics_init (void *error_buffer) Initializes a gl_area. @@ -56,25 +48,13 @@ Draws the current buffer to a gl_area. - bool graphics_shutdown (const int graphics_stack_id, void *error_buffer) + bool graphics_shutdown (const int id, void *error_buffer) Shutdowns a gl_area. bool graphics_init_shaders (const int graphics_stack_id) Initializes the shaders of a gl_area and link them to a program. - - bool graphics_init_graphics_stack (void *container_widget, GError *error_buffer) - -phantom documentation - - bool graphics_shutdown_graphics_stack (void *container_widget, GError *error_buffer) - -phantom documentation - - bool graphics_update_axis_stack (GtkWidget *container_widget, int axis, int value) - -phantom documentation void graphics_init_buffers (const int graphics_stack_id) @@ -82,7 +62,7 @@ void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z) -Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. +Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b) @@ -112,21 +92,15 @@ Writes grid ridges to vertex and color buffers. - int graphics_draw_space_ridges_lines (const int graphics_stack_id) + int graphics_draw_space_ridges_lines (const int graphics_stack_id) -draw_space_ridges_lines +phantom documentation used to test the functioning of doxygen long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z) Writes grid lines on space faces. long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) - -phantom documentation used to test the functioning of doxygen - - int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z) - -set_arrow @@ -152,7 +126,7 @@ graphics_draw() graphics_drawgraphics.h graphics.hgraphics_draw -void graphics_draw (const int stack_id) +void graphics_draw (const int graphics_stack_id) Draws the current buffer to a gl_area. @@ -168,10 +142,7 @@ Parameters -graphics_stack_id - - -stack_id +graphics_stack_id gl_area, ptr to the gl_area widget @@ -186,7 +157,7 @@ Parameters graphics_draw_color() graphics_draw_colorgraphics.h graphics.hgraphics_draw_color -void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b) +void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b) Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. @@ -214,41 +185,6 @@ Parameters g - - - -b - - - - - - - Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. - - - - -Parameters - - - - - - - -stack_id - - - - -r - - - - -g - @@ -267,11 +203,7 @@ Parameters graphics_draw_grids_on_space_faces_lines() graphics_draw_grids_on_space_faces_linesgraphics.h graphics.hgraphics_draw_grids_on_space_faces_lines -long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) - -phantom documentation used to test the functioning of doxygen - - +long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z) @@ -320,7 +252,7 @@ Parameters graphics_draw_grids_on_space_faces_vertex() graphics_draw_grids_on_space_faces_vertexgraphics.h graphics.hgraphics_draw_grids_on_space_faces_vertex -long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z) +long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z) Writes grid lines on space faces. @@ -360,21 +292,19 @@ Parameters Returns -l +l -Writes grid lines on space faces. +
    graphics_draw_line() graphics_draw_linegraphics.h graphics.hgraphics_draw_line -void graphics_draw_line (const int stack_id, GLuint a, GLuint b) +void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b) Writes values to describe a line from a to b into the line buffer. -@use liste de fonctions GTK - @@ -386,11 +316,6 @@ Parameters
    -coords -GLuint (a,b) - - - graphics_stack_id @@ -398,19 +323,6 @@ Parameters a - - - -b - - -stack_id - - - - -a - @@ -540,7 +452,7 @@ Parameters graphics_draw_plan() graphics_draw_plangraphics.h graphics.hgraphics_draw_plan -void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c) +void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c) Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. @@ -556,11 +468,6 @@ Parameters -coords -GLuint (a,b,c) - - - graphics_stack_id @@ -573,24 +480,6 @@ Parameters b - - - -c - - -stack_id - - - - -a - - - - -b - @@ -605,44 +494,11 @@ Parameters -
    - graphics_draw_space_ridges_lines() -graphics_draw_space_ridges_linesgraphics.h -graphics.hgraphics_draw_space_ridges_lines -int graphics_draw_space_ridges_lines (const int stack_id) - -draw_space_ridges_lines - - - - - -Parameters - -
    - - - - - -graphics_stack_id - - - -
    -     -     - Returns - -i - -draw_space_ridges_lines     -
    graphics_draw_space_ridges_vertex() graphics_draw_space_ridges_vertexgraphics.h graphics.hgraphics_draw_space_ridges_vertex -int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z) +int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z) Writes grid ridges to vertex and color buffers. @@ -695,9 +551,9 @@ Writes grid ridges to vertex and color buffers. graphics_draw_vertex() graphics_draw_vertexgraphics.h graphics.hgraphics_draw_vertex -void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z) +void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z) -Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. +Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. @@ -711,11 +567,6 @@ Parameters -GLfloat -x, GLfloat y, GLfloat z - - - graphics_stack_id @@ -728,41 +579,6 @@ Parameters y - - - -z - - - - - - - Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. - - - - -Parameters - - - - - - - -stack_id - - - - -x - - - - -y - @@ -810,25 +626,9 @@ Parameters true if initialized +param *error_buffer < DO NOT DOCUMENT (it's 'void') - - -Parameters - -
    - - - - - -*error_buffer - - - -
    -     -     - Returns +Returns true if initialized @@ -838,7 +638,7 @@ Parameters graphics_init_buffers() graphics_init_buffersgraphics.h graphics.hgraphics_init_buffers -void graphics_init_buffers (const int stack_id) +void graphics_init_buffers (const int graphics_stack_id) Initializes the buffer of a gl_area Calls according to the user preferences. @@ -854,17 +654,7 @@ Parameters -gl_area, ptr -to the gl_area widget - - - -graphics_stack_id -gl_area, ptr to the gl_area widget - - - -stack_id +graphics_stack_id @@ -877,7 +667,7 @@ Parameters graphics_init_shaders() graphics_init_shadersgraphics.h graphics.hgraphics_init_shaders -bool graphics_init_shaders (const int stack_id) +bool graphics_init_shaders (const int graphics_stack_id) Initializes the shaders of a gl_area and link them to a program. @@ -893,9 +683,7 @@ Parameters -graphics_stack_id -gl_area, ptr to the gl_area widget - +graphics_stack_id @@ -904,55 +692,7 @@ Parameters Returns -true if initialized - - - - -Parameters - - - - - - - -gl_area, ptr -to the gl_area widget - - - - -
    -     -     - Returns - -true if initialized - - - - -Parameters - - - - - - - -stack_id - - - -
    -     -     - gl_area, ptr to the gl_area widget     - -Returns - -true if initialized +initialized
    @@ -987,85 +727,7 @@ Parameters
    -
    - graphics_set_arrow() -graphics_set_arrowgraphics.h -graphics.hgraphics_set_arrow -int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z) - -set_arrow - - - - - -Parameters - - - - - - - -graphics_stack_id - - - - -arrows_nb - - - - -space_X - - - - -space_Y - - - - -space_Z - - - - -requested_weight - - - - -site - - - - -x - - - - -y - - - - -z - - - -
    -     -     - Returns - -i - -     -
    -
    +
    graphics_shutdown() graphics_shutdowngraphics.h graphics.hgraphics_shutdown @@ -1075,57 +737,6 @@ Parameters - - -Parameters - - - - - - - -graphics_stack_id - - - - -*error_buffer - - - -
    -     -     - Returns - -true if success - - - - -Parameters - - - - - - - -gl_area, ptr -to the gl_area widget - - - - -
    -     -     - Returns - -true if success - - Parameters @@ -1148,11 +759,9 @@ Parameters     - gl_area, ptr to the gl_area widget + Returns -Returns - -true if success +success
    diff --git a/doc/docbook/d7/d09/list__2x2_8c.xml b/doc/docbook/d7/d09/list__2x2_8c.xml index 9b32a08..8be0d15 100644 --- a/doc/docbook/d7/d09/list__2x2_8c.xml +++ b/doc/docbook/d7/d09/list__2x2_8c.xml @@ -4,7 +4,7 @@ src/util/list_2x2.c -Gem-graph-client util double_chained list. +double_chained list #include "../../include/util.h" @@ -47,7 +47,7 @@
    Detailed Description -Gem-graph-client util double_chained list. +double_chained list This file is part of Gem-graph.
    diff --git a/doc/docbook/d8/d00/init_8c.xml b/doc/docbook/d8/d00/init_8c.xml index 51ef4d5..259b873 100644 --- a/doc/docbook/d8/d00/init_8c.xml +++ b/doc/docbook/d8/d00/init_8c.xml @@ -27,15 +27,15 @@ Shutdowns a gl_area. - void graphics_model_setup (const int stack_id) + void graphics_model_setup (const int graphics_stack_id) graphics_model_setup - void graphics_init_buffers (const int stack_id) + void graphics_init_buffers (const int graphics_stack_id) Initializes the buffer of a gl_area Calls according to the user preferences. - bool graphics_init_shaders (const int stack_id) + bool graphics_init_shaders (const int graphics_stack_id) Initializes the shaders of a gl_area and link them to a program. @@ -80,35 +80,19 @@ Initializes a gl_area. - - - -Parameters - - - - - - - -*error_buffer - - - -
    -     -     - Returns +param *error_buffer < DO NOT DOCUMENT (it's 'void') + +Returns true if initialized
    -
    +
    graphics_init_buffers() graphics_init_buffersinit.c init.cgraphics_init_buffers -void graphics_init_buffers (const int stack_id) +void graphics_init_buffers (const int graphics_stack_id) Initializes the buffer of a gl_area Calls according to the user preferences. @@ -124,7 +108,7 @@ Parameters -stack_id +graphics_stack_id @@ -133,11 +117,11 @@ Parameters gl_area, ptr to the gl_area widget
    -
    +
    graphics_init_shaders() graphics_init_shadersinit.c init.cgraphics_init_shaders -bool graphics_init_shaders (const int stack_id) +bool graphics_init_shaders (const int graphics_stack_id) Initializes the shaders of a gl_area and link them to a program. @@ -153,22 +137,20 @@ Parameters -stack_id +graphics_stack_id - gl_area, ptr to the gl_area widget + Returns -Returns - -true if initialized +initialized
    -
    +
    graphics_model_setup() graphics_model_setupinit.c init.cgraphics_model_setup @@ -231,11 +213,9 @@ Parameters - gl_area, ptr to the gl_area widget + Returns -Returns - -true if success +success
    diff --git a/doc/docbook/d8/d01/strings__op_8c.xml b/doc/docbook/d8/d01/strings__op_8c.xml index c9cf2da..9ee82c0 100644 --- a/doc/docbook/d8/d01/strings__op_8c.xml +++ b/doc/docbook/d8/d01/strings__op_8c.xml @@ -4,7 +4,7 @@ src/util/strings_op.c -Gem-graph-client. +concat #include <stdlib.h>#include <stdarg.h>#include <string.h> @@ -19,7 +19,7 @@
    Detailed Description -Gem-graph-client. +concat This file is part of Gem-graph. diff --git a/doc/docbook/d8/d0c/util_8h.xml b/doc/docbook/d8/d0c/util_8h.xml index e5796e3..e4e2d57 100644 --- a/doc/docbook/d8/d0c/util_8h.xml +++ b/doc/docbook/d8/d0c/util_8h.xml @@ -12,19 +12,19 @@ struct pile -phantom documentation used to test the functioning of doxygen +phantom documentation struct elem -phantom documentation used to test the functioning of doxygen +simplest element of a double-chained list struct dblist -phantom documentation used to test the functioning of doxygen +required to init the empty list struct slist -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -33,15 +33,15 @@ typedef struct pile pile -phantom documentation used to test the functioning of doxygen +phantom documentation typedef struct elem elem -phantom documentation used to test the functioning of doxygen +simplest element of a double-chained list typedef struct slist slist -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -126,10 +126,6 @@ long util_gl_get_stack (void *container_widget) -Look for stack entry and returns stack_id. - - long util_gl_is_util_ready (void *container_widget) - Look for stack entry and returns stack_id. bool util_gl_init_stack (void *container_widget, GError *error_buffer) @@ -202,29 +198,7 @@ Parameters Returns -GtkWidget* pointer to the new widget - - - - -Parameters - - - - - - - -axis - - - -
    -     -     - Returns - -GtkWidget * +GtkWidget* pointer to the new widget
    @@ -280,30 +254,6 @@ Parameters - - -Parameters - - - - - - - -*container_widget -generally the GtkBox that contains the GLArea - - - - -
    -     -     - Returns - -stack_id - - Parameters @@ -337,30 +287,6 @@ Parameters     - - -Parameters - - - - - - - -*container_widget -generally the GtkBox that contains the GLArea - - - - -
    -     -     - Returns - -bool true if success - - Parameters @@ -387,41 +313,6 @@ Parameters
    -
    - util_gl_is_util_ready() -util_gl_is_util_readyutil.h -util.hutil_gl_is_util_ready -long util_gl_is_util_ready (void * container_widget) - -Look for stack entry and returns stack_id. - - - - - -Parameters - - - - - - - -*container_widget -generally the GtkBox that contains the GLArea - - - - -
    -     -     - Returns - -stack_id - -     -
    util_gl_render_stack() util_gl_render_stackutil.h @@ -432,30 +323,6 @@ Parameters - - -Parameters - - - - - - - -*container_widget -generally the GtkBox that contains the GLArea - - - - -
    -     -     - Returns - -bool true if success - - Parameters @@ -490,29 +357,9 @@ Parameters Look for every stack entry and shutdowns OpenGL for it.     - - - -Parameters - - - - - - - -void - - - -
    -     -     - Returns +DO NOT DOCUMENT param void < argument 'void' of command @ param is not found -bool true if success - -returns true if success ? TODO why not bool ?     +DO NOT DOCUMENT returns bool true if success < does not return anything
    util_gl_shutdown_stack() @@ -535,7 +382,7 @@ Parameters *container_widget -generally the GtkBox that contains the GLArea + @@ -548,7 +395,7 @@ Parameters Returns -bool: true if success +success
    diff --git a/doc/docbook/da/d03/structpile.xml b/doc/docbook/da/d03/structpile.xml index e129f3e..8c7cff6 100644 --- a/doc/docbook/da/d03/structpile.xml +++ b/doc/docbook/da/d03/structpile.xml @@ -4,7 +4,7 @@ pile -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -26,7 +26,7 @@
    Detailed Description -phantom documentation used to test the functioning of doxygen +phantom documentation The documentation for this struct was generated from the following file: include/util.h
    diff --git a/doc/docbook/da/d0c/gl_8c.xml b/doc/docbook/da/d0c/gl_8c.xml index af7b251..e948fb1 100644 --- a/doc/docbook/da/d0c/gl_8c.xml +++ b/doc/docbook/da/d0c/gl_8c.xml @@ -4,7 +4,7 @@ src/util/draw/gl.c -graphics - general drawing functions +general drawing functions #include "../../../include/graphics.h"#include "../../../include/signal.h" @@ -86,7 +86,7 @@
    Detailed Description -graphics - general drawing functions +general drawing functions This file is part of Gem-graph.
    @@ -112,7 +112,9 @@ Parameters -axis +axis +meaning which axis we're building (for label) + @@ -121,7 +123,7 @@ Parameters Returns -GtkWidget * +GtkWidget* pointer to the new widget
    @@ -347,7 +349,9 @@ Parameters Look for every stack entry and shutdowns OpenGL for it. -returns true if success ? TODO why not bool ? +DO NOT DOCUMENT param void < argument 'void' of command @ param is not found + +DO NOT DOCUMENT returns bool true if success < does not return anything
    util_gl_shutdown_stack() @@ -370,7 +374,7 @@ Parameters *container_widget -generally the GtkBox that contains the GLArea + @@ -383,7 +387,7 @@ Parameters Returns -bool: true if success +success
    diff --git a/doc/docbook/db/d02/designer_8c.xml b/doc/docbook/db/d02/designer_8c.xml index 2d2c744..a1ac7ce 100644 --- a/doc/docbook/db/d02/designer_8c.xml +++ b/doc/docbook/db/d02/designer_8c.xml @@ -4,7 +4,7 @@ src/widget/main_window/designer.c -main window +builds ans present #include "../../../include/widget.h"#include "../../../include/fsm.h"#include "../../../include/util.h" @@ -17,11 +17,15 @@
    Detailed Description -main window +builds ans present This file is part of Gem-graph. -Six pages can be displayed in the main window: +ensure the titlebar and the pages are available and init them + +triggers assembly of the topbar and the default page + +six pages can be displayed in the main window: synth: an overview that presents the main elements of interest simultaneously diff --git a/doc/docbook/db/d07/parse_8c.xml b/doc/docbook/db/d07/parse_8c.xml index 1df2479..39d818d 100644 --- a/doc/docbook/db/d07/parse_8c.xml +++ b/doc/docbook/db/d07/parse_8c.xml @@ -4,7 +4,7 @@ src/util/parse.c -Gem-graph-client parsing functions. +parsing XML #include <libxml/parser.h>#include <libxml/xmlreader.h>#include "../../include/base.h" @@ -84,7 +84,7 @@
    Detailed Description -Gem-graph-client parsing functions. +parsing XML This file is part of Gem-graph.
    diff --git a/doc/docbook/db/d08/pile_8c.xml b/doc/docbook/db/d08/pile_8c.xml index ed86a19..d40b1bd 100644 --- a/doc/docbook/db/d08/pile_8c.xml +++ b/doc/docbook/db/d08/pile_8c.xml @@ -4,7 +4,7 @@ src/util/pile.c -Gem-graph-client. +simple pile #include "../../include/util.h" @@ -25,7 +25,7 @@
    Detailed Description -Gem-graph-client. +simple pile This file is part of Gem-graph. It implements a simple pile functions.
    diff --git a/doc/docbook/dc/d0e/sorted__list_8c.xml b/doc/docbook/dc/d0e/sorted__list_8c.xml index 6daeaf8..926837d 100644 --- a/doc/docbook/dc/d0e/sorted__list_8c.xml +++ b/doc/docbook/dc/d0e/sorted__list_8c.xml @@ -4,7 +4,7 @@ src/util/sorted_list.c -Gem-graph-client. +simple sorted list #include "../../include/util.h" @@ -25,7 +25,7 @@
    Detailed Description -Gem-graph-client. +simple sorted list This file is part of Gem-graph. It implements a simple sorted list functions.
    diff --git a/doc/docbook/df/d05/structslist.xml b/doc/docbook/df/d05/structslist.xml index c22298e..e7cb499 100644 --- a/doc/docbook/df/d05/structslist.xml +++ b/doc/docbook/df/d05/structslist.xml @@ -4,7 +4,7 @@ slist -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -26,7 +26,7 @@
    Detailed Description -phantom documentation used to test the functioning of doxygen +phantom documentation The documentation for this struct was generated from the following file: include/util.h
    diff --git a/doc/docbook/df/d0a/io_8c.xml b/doc/docbook/df/d0a/io_8c.xml index 020a738..4ec27fc 100644 --- a/doc/docbook/df/d0a/io_8c.xml +++ b/doc/docbook/df/d0a/io_8c.xml @@ -4,7 +4,7 @@ src/util/io.c -Gem-graph-client util input output. +input output #include <assert.h>#include <errno.h>#include <fcntl.h>#include <math.h>#include <stdio.h>#include <stdlib.h>#include <stddef.h>#include <stdbool.h>#include <sys/types.h>#include <sys/stat.h>#include <unistd.h>#include <time.h>#include "../../include/util.h" @@ -19,7 +19,7 @@
    Detailed Description -Gem-graph-client util input output. +input output This file is part of Gem-graph.
    diff --git a/doc/rtfm/man3/dblist.3 b/doc/rtfm/man3/dblist.3 index 22387f2..d24b144 100644 --- a/doc/rtfm/man3/dblist.3 +++ b/doc/rtfm/man3/dblist.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -dblist \- phantom documentation used to test the functioning of doxygen +dblist \- required to init the empty list .SH SYNOPSIS .br @@ -23,7 +23,7 @@ dblist \- phantom documentation used to test the functioning of doxygen .in -1c .SH "Detailed Description" .PP -phantom documentation used to test the functioning of doxygen +required to init the empty list .SH "Author" .PP diff --git a/doc/rtfm/man3/designer.c.3 b/doc/rtfm/man3/designer.c.3 index f538257..b1a4c85 100644 --- a/doc/rtfm/man3/designer.c.3 +++ b/doc/rtfm/man3/designer.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/widget/main_window/designer.c \- main window +src/widget/main_window/designer.c \- builds ans present .SH SYNOPSIS .br @@ -23,11 +23,15 @@ src/widget/main_window/designer.c \- main window .in -1c .SH "Detailed Description" .PP -main window +builds ans present This file is part of Gem-graph\&. .PP -Six pages can be displayed in the main window: +ensure the titlebar and the pages are available and init them +.PP +triggers assembly of the topbar and the default page +.PP +six pages can be displayed in the main window: .IP "\(bu" 2 synth: an overview that presents the main elements of interest simultaneously .IP "\(bu" 2 diff --git a/doc/rtfm/man3/draw.c.3 b/doc/rtfm/man3/draw.c.3 index aac74d3..c25afaa 100644 --- a/doc/rtfm/man3/draw.c.3 +++ b/doc/rtfm/man3/draw.c.3 @@ -18,23 +18,23 @@ src/graphics/draw.c \- graphics - general drawing functions .in +1c .ti -1c -.RI "void \fBgraphics_draw_vertex\fP (const int stack_id, GLfloat x, GLfloat y, GLfloat z)" +.RI "void \fBgraphics_draw_vertex\fP (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)" .br .RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. " .ti -1c -.RI "void \fBgraphics_draw_color\fP (const int stack_id, GLfloat r, GLfloat g, GLfloat b)" +.RI "void \fBgraphics_draw_color\fP (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)" .br -.RI "Writes values to describe a color (r,g,b) into the color buffer\&. " +.RI "Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. " .ti -1c -.RI "void \fBgraphics_draw_line\fP (const int stack_id, GLuint a, GLuint b)" +.RI "void \fBgraphics_draw_line\fP (const int graphics_stack_id, GLuint a, GLuint b)" .br .RI "Writes values to describe a line from a to b into the line buffer\&. " .ti -1c -.RI "void \fBgraphics_draw_plan\fP (const int stack_id, GLuint a, GLuint b, GLuint c)" +.RI "void \fBgraphics_draw_plan\fP (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)" .br .RI "Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. " .ti -1c -.RI "void \fBgraphics_draw\fP (const int stack_id)" +.RI "void \fBgraphics_draw\fP (const int graphics_stack_id)" .br .RI "Draws the current buffer to a gl_area\&. " .in -1c @@ -45,25 +45,25 @@ graphics - general drawing functions This file is part of Gem-graph\&. .SH "Function Documentation" .PP -.SS "void graphics_draw (const int stack_id)" +.SS "void graphics_draw (const int graphics_stack_id)" .PP Draws the current buffer to a gl_area\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP gl_area, ptr to the gl_area widget +\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget .RE .PP -.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)" +.SS "void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)" .PP -Writes values to describe a color (r,g,b) into the color buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. +Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .br \fIr\fP .br @@ -73,14 +73,14 @@ Writes values to describe a color (r,g,b) into the color buffer\&. Draws the col .RE .PP -.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)" +.SS "void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)" .PP Writes values to describe a line from a to b into the line buffer\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .br \fIa\fP .br @@ -88,14 +88,14 @@ Writes values to describe a line from a to b into the line buffer\&. .RE .PP -.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)" +.SS "void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)" .PP Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .br \fIa\fP .br @@ -105,14 +105,14 @@ Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. .RE .PP -.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)" +.SS "void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)" .PP -Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. +Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .br \fIx\fP .br diff --git a/doc/rtfm/man3/elem.3 b/doc/rtfm/man3/elem.3 index 7470024..42e3e06 100644 --- a/doc/rtfm/man3/elem.3 +++ b/doc/rtfm/man3/elem.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -elem \- phantom documentation used to test the functioning of doxygen +elem \- simplest element of a double-chained list .SH SYNOPSIS .br @@ -27,7 +27,7 @@ elem \- phantom documentation used to test the functioning of doxygen .in -1c .SH "Detailed Description" .PP -phantom documentation used to test the functioning of doxygen +simplest element of a double-chained list .SH "Author" .PP diff --git a/doc/rtfm/man3/gl.c.3 b/doc/rtfm/man3/gl.c.3 index 0c10712..d3bbe1d 100644 --- a/doc/rtfm/man3/gl.c.3 +++ b/doc/rtfm/man3/gl.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/draw/gl.c \- graphics - general drawing functions +src/util/draw/gl.c \- general drawing functions .SH SYNOPSIS .br @@ -86,7 +86,7 @@ src/util/draw/gl.c \- graphics - general drawing functions .in -1c .SH "Detailed Description" .PP -graphics - general drawing functions +general drawing functions This file is part of Gem-graph\&. .SH "Function Documentation" @@ -98,12 +98,12 @@ Creates a slider widget\&. .PP \fBParameters\fP .RS 4 -\fIaxis\fP +\fIaxis\fP meaning which axis we're building (for label) .RE .PP \fBReturns\fP .RS 4 -GtkWidget * +GtkWidget* pointer to the new widget .RE .PP @@ -205,7 +205,9 @@ returns int .SS "void util_gl_shutdown_all_stacks (void)" .PP -Look for every stack entry and shutdowns OpenGL for it\&. returns true if success ? TODO why not bool ? +Look for every stack entry and shutdowns OpenGL for it\&. DO NOT DOCUMENT param void < argument 'void' of command @ param is not found +.PP +DO NOT DOCUMENT returns bool true if success < does not return anything .SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)" .PP @@ -213,14 +215,14 @@ Look for stack entry and shutdowns OpenGL for it\&. .PP \fBParameters\fP .RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea +\fI*container_widget\fP .br \fI*error_buffer\fP .RE .PP \fBReturns\fP .RS 4 -bool: true if success +success .RE .PP diff --git a/doc/rtfm/man3/graphics.h.3 b/doc/rtfm/man3/graphics.h.3 index 31cf606..8e47341 100644 --- a/doc/rtfm/man3/graphics.h.3 +++ b/doc/rtfm/man3/graphics.h.3 @@ -46,14 +46,6 @@ include/graphics.h \- graphics header .in +1c .ti -1c -.RI "bool \fBgraphics_render_stack\fP (GtkWidget *container_widget)" -.br -.RI "Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas\&. " -.ti -1c -.RI "bool \fBgraphics_setup_glarea\fP (int target_mode, GtkWidget *target_widget)" -.br -.RI "phantom documentation " -.ti -1c .RI "int \fBgraphics_init\fP (void *error_buffer)" .br .RI "Initializes a gl_area\&. " @@ -62,7 +54,7 @@ include/graphics.h \- graphics header .br .RI "Draws the current buffer to a gl_area\&. " .ti -1c -.RI "bool \fBgraphics_shutdown\fP (const int graphics_stack_id, void *error_buffer)" +.RI "bool \fBgraphics_shutdown\fP (const int id, void *error_buffer)" .br .RI "Shutdowns a gl_area\&. " .ti -1c @@ -70,25 +62,13 @@ include/graphics.h \- graphics header .br .RI "Initializes the shaders of a gl_area and link them to a program\&. " .ti -1c -.RI "bool \fBgraphics_init_graphics_stack\fP (void *container_widget, GError *error_buffer)" -.br -.RI "phantom documentation " -.ti -1c -.RI "bool \fBgraphics_shutdown_graphics_stack\fP (void *container_widget, GError *error_buffer)" -.br -.RI "phantom documentation " -.ti -1c -.RI "bool \fBgraphics_update_axis_stack\fP (GtkWidget *container_widget, int axis, int value)" -.br -.RI "phantom documentation " -.ti -1c .RI "void \fBgraphics_init_buffers\fP (const int graphics_stack_id)" .br .RI "Initializes the buffer of a gl_area Calls according to the user preferences\&. " .ti -1c .RI "void \fBgraphics_draw_vertex\fP (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)" .br -.RI "Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. " +.RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. " .ti -1c .RI "void \fBgraphics_draw_line\fP (const int graphics_stack_id, GLuint a, GLuint b)" .br @@ -120,7 +100,7 @@ include/graphics.h \- graphics header .ti -1c .RI "int \fBgraphics_draw_space_ridges_lines\fP (const int graphics_stack_id)" .br -.RI "draw_space_ridges_lines " +.RI "phantom documentation used to test the functioning of doxygen " .ti -1c .RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int graphics_stack_id, long x, long y, long z)" .br @@ -128,11 +108,6 @@ include/graphics.h \- graphics header .ti -1c .RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" .br -.RI "phantom documentation used to test the functioning of doxygen " -.ti -1c -.RI "int \fBgraphics_set_arrow\fP (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)" -.br -.RI "set_arrow " .in -1c .SS "Variables" @@ -149,20 +124,18 @@ graphics header This file is part of Gem-graph\&. .SH "Function Documentation" .PP -.SS "void graphics_draw (const int stack_id)" +.SS "void graphics_draw (const int graphics_stack_id)" .PP Draws the current buffer to a gl_area\&. .PP \fBParameters\fP .RS 4 -\fIgraphics_stack_id\fP -.br -\fIstack_id\fP gl_area, ptr to the gl_area widget +\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget .RE .PP -.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)" +.SS "void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)" .PP Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. @@ -178,24 +151,9 @@ Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) v \fIb\fP .RE .PP -Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. -.PP -\fBParameters\fP -.RS 4 -\fIstack_id\fP -.br -\fIr\fP -.br -\fIg\fP -.br -\fIb\fP -.RE -.PP .SS "long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" -.PP -phantom documentation used to test the functioning of doxygen .PP \fBParameters\fP .RS 4 @@ -216,7 +174,7 @@ l .RE .PP -.SS "long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)" +.SS "long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)" .PP Writes grid lines on space faces\&. @@ -234,30 +192,22 @@ Writes grid lines on space faces\&. .PP \fBReturns\fP .RS 4 -l +l .RE .PP -Writes grid lines on space faces\&. -.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)" + +.SS "void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)" .PP -Writes values to describe a line from a to b into the line buffer\&. @use liste de fonctions GTK +Writes values to describe a line from a to b into the line buffer\&. .PP \fBParameters\fP .RS 4 -\fIcoords\fP GLuint (a,b) -.br \fIgraphics_stack_id\fP .br \fIa\fP .br \fIb\fP -.br -\fIstack_id\fP -.br -\fIa\fP -.br -\fIb\fP .RE .PP @@ -311,15 +261,13 @@ i .RE .PP -.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)" +.SS "void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)" .PP Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. .PP \fBParameters\fP .RS 4 -\fIcoords\fP GLuint (a,b,c) -.br \fIgraphics_stack_id\fP .br \fIa\fP @@ -327,34 +275,10 @@ Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. \fIb\fP .br \fIc\fP -.br -\fIstack_id\fP -.br -\fIa\fP -.br -\fIb\fP -.br -\fIc\fP .RE .PP -.SS "int graphics_draw_space_ridges_lines (const int stack_id)" - -.PP -draw_space_ridges_lines -.PP -\fBParameters\fP -.RS 4 -\fIgraphics_stack_id\fP -.RE -.PP -\fBReturns\fP -.RS 4 -i -.RE -.PP -draw_space_ridges_lines -.SS "int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)" +.SS "int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" .PP Writes grid ridges to vertex and color buffers\&. @@ -378,15 +302,13 @@ i .RE .PP Writes grid ridges to vertex and color buffers\&. -.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)" +.SS "void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)" .PP -Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. +Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. .PP \fBParameters\fP .RS 4 -\fIGLfloat\fP x, GLfloat y, GLfloat z -.br \fIgraphics_stack_id\fP .br \fIx\fP @@ -396,19 +318,6 @@ Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. \fIz\fP .RE .PP -Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. -.PP -\fBParameters\fP -.RS 4 -\fIstack_id\fP -.br -\fIx\fP -.br -\fIy\fP -.br -\fIz\fP -.RE -.PP .SS "int graphics_init (void * error_buffer)" @@ -425,10 +334,7 @@ Initializes a gl_area\&. true if initialized .RE .PP -\fBParameters\fP -.RS 4 -\fI*error_buffer\fP -.RE +param *error_buffer < DO NOT DOCUMENT (it's 'void') .PP \fBReturns\fP .RS 4 @@ -436,56 +342,30 @@ true if initialized .RE .PP -.SS "void graphics_init_buffers (const int stack_id)" +.SS "void graphics_init_buffers (const int graphics_stack_id)" .PP Initializes the buffer of a gl_area Calls according to the user preferences\&. .PP \fBParameters\fP .RS 4 -\fIgl_area,ptr\fP to the gl_area widget -.br -\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget -.br -\fIstack_id\fP +\fIgraphics_stack_id\fP .RE .PP gl_area, ptr to the gl_area widget -.SS "bool graphics_init_shaders (const int stack_id)" +.SS "bool graphics_init_shaders (const int graphics_stack_id)" .PP Initializes the shaders of a gl_area and link them to a program\&. .PP \fBParameters\fP .RS 4 -\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget +\fIgraphics_stack_id\fP .RE .PP \fBReturns\fP .RS 4 -true if initialized -.RE -.PP -\fBParameters\fP -.RS 4 -\fIgl_area,ptr\fP to the gl_area widget -.RE -.PP -\fBReturns\fP -.RS 4 -true if initialized -.RE -.PP -\fBParameters\fP -.RS 4 -\fIstack_id\fP -.RE -.PP -gl_area, ptr to the gl_area widget -.PP -\fBReturns\fP -.RS 4 -true if initialized +initialized .RE .PP @@ -500,40 +380,6 @@ graphics_model_setup .RE .PP -.SS "int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)" - -.PP -set_arrow -.PP -\fBParameters\fP -.RS 4 -\fIgraphics_stack_id\fP -.br -\fIarrows_nb\fP -.br -\fIspace_X\fP -.br -\fIspace_Y\fP -.br -\fIspace_Z\fP -.br -\fIrequested_weight\fP -.br -\fIsite\fP -.br -\fIx\fP -.br -\fIy\fP -.br -\fIz\fP -.RE -.PP -\fBReturns\fP -.RS 4 -i -.RE -.PP - .SS "bool graphics_shutdown (const int id, void * error_buffer)" .PP @@ -541,38 +387,14 @@ Shutdowns a gl_area\&. .PP \fBParameters\fP .RS 4 -\fIgraphics_stack_id\fP -.br -\fI*error_buffer\fP -.RE -.PP -\fBReturns\fP -.RS 4 -true if success -.RE -.PP -\fBParameters\fP -.RS 4 -\fIgl_area,ptr\fP to the gl_area widget -.RE -.PP -\fBReturns\fP -.RS 4 -true if success -.RE -.PP -\fBParameters\fP -.RS 4 \fIid\fP .br \fI*error_buffer\fP .RE .PP -gl_area, ptr to the gl_area widget -.PP \fBReturns\fP .RS 4 -true if success +success .RE .PP diff --git a/doc/rtfm/man3/grid.c.3 b/doc/rtfm/man3/grid.c.3 index e48a4fc..6dcf686 100644 --- a/doc/rtfm/man3/grid.c.3 +++ b/doc/rtfm/man3/grid.c.3 @@ -14,21 +14,20 @@ src/graphics/grid.c \- graphics - grid/empty space drawing functions .in +1c .ti -1c -.RI "int \fBgraphics_draw_space_ridges_vertex\fP (const int stack_id, long offset_vertex, long x, long y, long z)" +.RI "int \fBgraphics_draw_space_ridges_vertex\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" .br .RI "phantom documentation used to test the functioning of doxygen " .ti -1c -.RI "int \fBgraphics_draw_space_ridges_lines\fP (const int stack_id)" +.RI "int \fBgraphics_draw_space_ridges_lines\fP (const int graphics_stack_id)" .br .RI "phantom documentation used to test the functioning of doxygen " .ti -1c -.RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int stack_id, long x, long y, long z)" +.RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int graphics_stack_id, long x, long y, long z)" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "Writes grid lines on space faces\&. " .ti -1c -.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int stack_id, long offset_vertex, long x, long y, long z)" +.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" .br -.RI "phantom documentation used to test the functioning of doxygen " .in -1c .SH "Detailed Description" .PP @@ -39,8 +38,6 @@ This file is part of Gem-graph\&. .PP .SS "long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" -.PP -phantom documentation used to test the functioning of doxygen .PP \fBParameters\fP .RS 4 @@ -61,15 +58,29 @@ l .RE .PP -.SS "long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)" +.SS "long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)" .PP -phantom documentation used to test the functioning of doxygen Writes grid lines on space faces\&. -.SS "int graphics_draw_space_ridges_lines (const int stack_id)" - +Writes grid lines on space faces\&. .PP -phantom documentation used to test the functioning of doxygen draw_space_ridges_lines -.SS "int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)" +\fBParameters\fP +.RS 4 +\fIgraphics_stack_id\fP +.br +\fIx\fP +.br +\fIy\fP +.br +\fIz\fP +.RE +.PP +\fBReturns\fP +.RS 4 +l +.RE +.PP + +.SS "int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)" .PP phantom documentation used to test the functioning of doxygen Writes grid ridges to vertex and color buffers\&. diff --git a/doc/rtfm/man3/init.c.3 b/doc/rtfm/man3/init.c.3 index 9f209ff..5de1653 100644 --- a/doc/rtfm/man3/init.c.3 +++ b/doc/rtfm/man3/init.c.3 @@ -34,15 +34,15 @@ src/graphics/init.c \- graphics - initialization and graphic stack management .br .RI "Shutdowns a gl_area\&. " .ti -1c -.RI "void \fBgraphics_model_setup\fP (const int stack_id)" +.RI "void \fBgraphics_model_setup\fP (const int graphics_stack_id)" .br .RI "graphics_model_setup " .ti -1c -.RI "void \fBgraphics_init_buffers\fP (const int stack_id)" +.RI "void \fBgraphics_init_buffers\fP (const int graphics_stack_id)" .br .RI "Initializes the buffer of a gl_area Calls according to the user preferences\&. " .ti -1c -.RI "bool \fBgraphics_init_shaders\fP (const int stack_id)" +.RI "bool \fBgraphics_init_shaders\fP (const int graphics_stack_id)" .br .RI "Initializes the shaders of a gl_area and link them to a program\&. " .in -1c @@ -76,12 +76,7 @@ This file is part of Gem-graph\&. .SS "int graphics_init (void * error_buffer)" .PP -Initializes a gl_area\&. -.PP -\fBParameters\fP -.RS 4 -\fI*error_buffer\fP -.RE +Initializes a gl_area\&. param *error_buffer < DO NOT DOCUMENT (it's 'void') .PP \fBReturns\fP .RS 4 @@ -89,32 +84,30 @@ true if initialized .RE .PP -.SS "void graphics_init_buffers (const int stack_id)" +.SS "void graphics_init_buffers (const int graphics_stack_id)" .PP Initializes the buffer of a gl_area Calls according to the user preferences\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .RE .PP gl_area, ptr to the gl_area widget -.SS "bool graphics_init_shaders (const int stack_id)" +.SS "bool graphics_init_shaders (const int graphics_stack_id)" .PP Initializes the shaders of a gl_area and link them to a program\&. .PP \fBParameters\fP .RS 4 -\fIstack_id\fP +\fIgraphics_stack_id\fP .RE .PP -gl_area, ptr to the gl_area widget -.PP \fBReturns\fP .RS 4 -true if initialized +initialized .RE .PP @@ -141,11 +134,9 @@ Shutdowns a gl_area\&. \fI*error_buffer\fP .RE .PP -gl_area, ptr to the gl_area widget -.PP \fBReturns\fP .RS 4 -true if success +success .RE .PP diff --git a/doc/rtfm/man3/io.c.3 b/doc/rtfm/man3/io.c.3 index 7144a38..986a962 100644 --- a/doc/rtfm/man3/io.c.3 +++ b/doc/rtfm/man3/io.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/io.c \- Gem-graph-client util input output\&. +src/util/io.c \- input output .SH SYNOPSIS .br @@ -44,7 +44,7 @@ src/util/io.c \- Gem-graph-client util input output\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client util input output\&. +input output This file is part of Gem-graph\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/list_2x2.c.3 b/doc/rtfm/man3/list_2x2.c.3 index 980b998..e22a4f7 100644 --- a/doc/rtfm/man3/list_2x2.c.3 +++ b/doc/rtfm/man3/list_2x2.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/list_2x2.c \- Gem-graph-client util double_chained list\&. +src/util/list_2x2.c \- double_chained list .SH SYNOPSIS .br @@ -48,7 +48,7 @@ src/util/list_2x2.c \- Gem-graph-client util double_chained list\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client util double_chained list\&. +double_chained list This file is part of Gem-graph\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/parse.c.3 b/doc/rtfm/man3/parse.c.3 index 3a51df6..a46ec42 100644 --- a/doc/rtfm/man3/parse.c.3 +++ b/doc/rtfm/man3/parse.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/parse.c \- Gem-graph-client parsing functions\&. +src/util/parse.c \- parsing XML .SH SYNOPSIS .br @@ -88,7 +88,7 @@ src/util/parse.c \- Gem-graph-client parsing functions\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client parsing functions\&. +parsing XML This file is part of Gem-graph\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/pile.3 b/doc/rtfm/man3/pile.3 index dc8d8ff..5808559 100644 --- a/doc/rtfm/man3/pile.3 +++ b/doc/rtfm/man3/pile.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -pile \- phantom documentation used to test the functioning of doxygen +pile \- phantom documentation .SH SYNOPSIS .br @@ -23,7 +23,7 @@ pile \- phantom documentation used to test the functioning of doxygen .in -1c .SH "Detailed Description" .PP -phantom documentation used to test the functioning of doxygen +phantom documentation .SH "Author" .PP diff --git a/doc/rtfm/man3/pile.c.3 b/doc/rtfm/man3/pile.c.3 index 90ce644..170ed72 100644 --- a/doc/rtfm/man3/pile.c.3 +++ b/doc/rtfm/man3/pile.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/pile.c \- Gem-graph-client\&. +src/util/pile.c \- simple pile .SH SYNOPSIS .br @@ -31,7 +31,7 @@ src/util/pile.c \- Gem-graph-client\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client\&. +simple pile This file is part of Gem-graph\&. It implements a simple pile functions\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/slist.3 b/doc/rtfm/man3/slist.3 index 1818c68..d72e9d0 100644 --- a/doc/rtfm/man3/slist.3 +++ b/doc/rtfm/man3/slist.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -slist \- phantom documentation used to test the functioning of doxygen +slist \- phantom documentation .SH SYNOPSIS .br @@ -23,7 +23,7 @@ slist \- phantom documentation used to test the functioning of doxygen .in -1c .SH "Detailed Description" .PP -phantom documentation used to test the functioning of doxygen +phantom documentation .SH "Author" .PP diff --git a/doc/rtfm/man3/sorted_list.c.3 b/doc/rtfm/man3/sorted_list.c.3 index 42bd79d..41778ba 100644 --- a/doc/rtfm/man3/sorted_list.c.3 +++ b/doc/rtfm/man3/sorted_list.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/sorted_list.c \- Gem-graph-client\&. +src/util/sorted_list.c \- simple sorted list .SH SYNOPSIS .br @@ -31,7 +31,7 @@ src/util/sorted_list.c \- Gem-graph-client\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client\&. +simple sorted list This file is part of Gem-graph\&. It implements a simple sorted list functions\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/strings_op.c.3 b/doc/rtfm/man3/strings_op.c.3 index 37cd699..9f010fe 100644 --- a/doc/rtfm/man3/strings_op.c.3 +++ b/doc/rtfm/man3/strings_op.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/strings_op.c \- Gem-graph-client\&. +src/util/strings_op.c \- concat .SH SYNOPSIS .br @@ -24,7 +24,7 @@ src/util/strings_op.c \- Gem-graph-client\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client\&. +concat This file is part of Gem-graph\&. .PP diff --git a/doc/rtfm/man3/tests.c.3 b/doc/rtfm/man3/tests.c.3 index 48a540c..487c833 100644 --- a/doc/rtfm/man3/tests.c.3 +++ b/doc/rtfm/man3/tests.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/util/tests.c \- Gem-graph-client\&. +src/util/tests.c \- use to check utilities .SH SYNOPSIS .br @@ -36,7 +36,7 @@ src/util/tests.c \- Gem-graph-client\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client\&. +use to check utilities This file is part of Gem-graph\&. It only groups various tests\&. .SH "Author" diff --git a/doc/rtfm/man3/util.h.3 b/doc/rtfm/man3/util.h.3 index 5f6c154..7b1a8c7 100644 --- a/doc/rtfm/man3/util.h.3 +++ b/doc/rtfm/man3/util.h.3 @@ -22,19 +22,19 @@ include/util.h \- utilities header .ti -1c .RI "struct \fBpile\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .ti -1c .RI "struct \fBelem\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "simplest element of a double-chained list " .ti -1c .RI "struct \fBdblist\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "required to init the empty list " .ti -1c .RI "struct \fBslist\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SS "Typedefs" @@ -42,15 +42,15 @@ include/util.h \- utilities header .ti -1c .RI "typedef struct \fBpile\fP \fBpile\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .ti -1c .RI "typedef struct \fBelem\fP \fBelem\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "simplest element of a double-chained list " .ti -1c .RI "typedef struct \fBslist\fP \fBslist\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SS "Functions" @@ -146,10 +146,6 @@ include/util.h \- utilities header .br .RI "Look for stack entry and returns stack_id\&. " .ti -1c -.RI "long \fButil_gl_is_util_ready\fP (void *container_widget)" -.br -.RI "Look for stack entry and returns stack_id\&. " -.ti -1c .RI "bool \fButil_gl_init_stack\fP (void *container_widget, GError *error_buffer)" .br .RI "Look for stack entry and initializes OpenGL for it\&. " @@ -197,17 +193,7 @@ Creates a slider widget\&. .PP \fBReturns\fP .RS 4 -GtkWidget* pointer to the new widget -.RE -.PP -\fBParameters\fP -.RS 4 -\fIaxis\fP -.RE -.PP -\fBReturns\fP -.RS 4 -GtkWidget * +GtkWidget* pointer to the new widget .RE .PP @@ -241,16 +227,6 @@ Look for stack entry and returns stack_id\&. .PP \fBParameters\fP .RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea -.RE -.PP -\fBReturns\fP -.RS 4 -stack_id -.RE -.PP -\fBParameters\fP -.RS 4 \fI*container_widget\fP .RE .PP @@ -267,16 +243,6 @@ Look for stack entry and initializes OpenGL for it\&. .PP \fBParameters\fP .RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea -.RE -.PP -\fBReturns\fP -.RS 4 -bool true if success -.RE -.PP -\fBParameters\fP -.RS 4 \fI*container_widget\fP .br \fI*error_buffer\fP @@ -288,22 +254,6 @@ success .RE .PP -.SS "long util_gl_is_util_ready (void * container_widget)" - -.PP -Look for stack entry and returns stack_id\&. -.PP -\fBParameters\fP -.RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea -.RE -.PP -\fBReturns\fP -.RS 4 -stack_id -.RE -.PP - .SS "bool util_gl_render_stack (GtkWidget * container_widget)" .PP @@ -311,16 +261,6 @@ Look for stack entry and triggers OpenGL for drawing\&. .PP \fBParameters\fP .RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea -.RE -.PP -\fBReturns\fP -.RS 4 -bool true if success -.RE -.PP -\fBParameters\fP -.RS 4 \fIcontainer_widget\fP generally the GtkBox that contains the GLArea .RE .PP @@ -333,19 +273,9 @@ bool: true if success .SS "void util_gl_shutdown_all_stacks (void)" .PP -Look for every stack entry and shutdowns OpenGL for it\&. +Look for every stack entry and shutdowns OpenGL for it\&. DO NOT DOCUMENT param void < argument 'void' of command @ param is not found .PP -\fBParameters\fP -.RS 4 -\fIvoid\fP -.RE -.PP -\fBReturns\fP -.RS 4 -bool true if success -.RE -.PP -returns true if success ? TODO why not bool ? +DO NOT DOCUMENT returns bool true if success < does not return anything .SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)" .PP @@ -353,14 +283,14 @@ Look for stack entry and shutdowns OpenGL for it\&. .PP \fBParameters\fP .RS 4 -\fI*container_widget\fP generally the GtkBox that contains the GLArea +\fI*container_widget\fP .br \fI*error_buffer\fP .RE .PP \fBReturns\fP .RS 4 -bool: true if success +success .RE .PP diff --git a/include/graphics.h b/include/graphics.h index cc165b2..ad92125 100644 --- a/include/graphics.h +++ b/include/graphics.h @@ -83,66 +83,16 @@ struct graphics_stack_t { */ extern struct graphics_stack_t *graphics_stack; -/** - * Structure describing a gl_area and its parameters, used to create a table - * of Gem-graph client current gl_areas - */ -bool graphics_render_stack(GtkWidget *container_widget); - -/** phantom documentation */ -bool graphics_setup_glarea(int target_mode, GtkWidget *target_widget); - +//bool graphics_render_stack(GtkWidget *container_widget); +//bool graphics_setup_glarea(int target_mode, GtkWidget *target_widget); int graphics_init(void *error_buffer); - -/** - * Draws the current buffer to a gl_area - * - * @param graphics_stack_id - */ void graphics_draw(const int graphics_stack_id); - -/** - * Shutdowns a gl_area - * - * @param graphics_stack_id - * @param *error_buffer - * - * @return true if success - */ -bool graphics_shutdown(const int graphics_stack_id, void *error_buffer); - -/** - * Initializes the shaders of a gl_area and link them to a program - * - * @param graphics_stack_id - * gl_area, ptr to the gl_area widget - * - * @return true if initialized - */ +bool graphics_shutdown(const int id, void *error_buffer); bool graphics_init_shaders(const int graphics_stack_id); - -/** phantom documentation */ -bool graphics_init_graphics_stack(void *container_widget, GError *error_buffer); - -/** phantom documentation */ -bool graphics_shutdown_graphics_stack(void *container_widget, GError *error_buffer); - -/** phantom documentation */ -bool graphics_update_axis_stack(GtkWidget *container_widget, int axis, int value); - -/** - * Initializes the buffer of a gl_area - * Calls according to the user preferences - * @param gl_area, ptr to the gl_area widget - */ +//bool graphics_init_graphics_stack(void *container_widget, GError *error_buffer); +//bool graphics_shutdown_graphics_stack(void *container_widget, GError *error_buffer); +//bool graphics_update_axis_stack(GtkWidget *container_widget, int axis, int value); void graphics_init_buffers(const int graphics_stack_id); - -/** - * Draws a vertex (x, y, z) - * if (console) prints (x, y, z) values to console - * - * @param GLfloat x, GLfloat y, GLfloat z - */ void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, @@ -155,22 +105,11 @@ void graphics_draw_vertex (const int graphics_stack_id, * @param GLfloat r, GLfloat g, GLfloat b * */ + //void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b); -/** - * Writes values to describe a line from a to b into the line buffer - * - * @use liste de fonctions GTK - * - * @param coords GLuint (a,b) - */ void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b); -/** - * Writes values to describe an (a,b,c) plan (triangle) into the plan buffer - * - * @param coords GLuint (a,b,c) - */ void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c); /** @@ -273,70 +212,16 @@ static inline void graphics_print_stack(int graphics_stack_id) */ int graphics_init(void *error_buffer); -/* - * Draws the current buffer to a gl_area - * - * @param gl_area, ptr to the gl_area widget - */ -//void graphics_draw(const int graphics_stack_id); - -/** - * Shutdowns a gl_area - * - * @param gl_area, ptr to the gl_area widget - * - * @return true if success - */ -bool graphics_shutdown(const int graphics_stack_id, void *error_buffer); - -/** - * Initializes the shaders of a gl_area and link them to a program - * - * @param gl_area, ptr to the gl_area widget - * - * @return true if initialized - */ -bool graphics_init_shaders(const int graphics_stack_id); - -/** - * Initializes the buffer of a gl_area - * Calls according to the user preferences - * @param graphics_stack_id gl_area, ptr to the gl_area widget - */ -void graphics_init_buffers(const int graphics_stack_id); - -/** - * Draws a vertex (x, y, z) - * if (console) prints (x, y, z) values to console - * - * @param graphics_stack_id - * @param x - * @param y - * @param z - */ void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z); -/** - * Draws the color (r, g, b) associated to a vertex - * if (console) prints (r, g, b) values to console - * - * @param graphics_stack_id - * @param r - * @param g - * @param b - */ -void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b); +void graphics_draw_color (const int graphics_stack_id, + GLfloat r, + GLfloat g, + GLfloat b); -/** - * Writes values to describe a line from a to b into the line buffer - * - * @param graphics_stack_id - * @param a - * @param b - */ void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b); /** @@ -411,62 +296,22 @@ int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long y, long z); -/** - * draw_space_ridges_lines - * - * @param graphics_stack_id - * - * @returns i - */ int graphics_draw_space_ridges_lines (const int graphics_stack_id); -/** - * Writes grid lines on space faces - * - * @param graphics_stack_id - * @param x - * @param y - * @param z - * - * @returns l - */ long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z); -/** - * @param graphics_stack_id - * @param offset_vertex - * @param x - * @param y - * @param z - * - * @returns l - */ long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z); -/** - * set_arrow - * - * @param graphics_stack_id - * @param arrows_nb - * @param space_X - * @param space_Y - * @param space_Z - * @param requested_weight - * @param site - * @param x - * @param y - * @param z - * - * @returns i - */ -int graphics_set_arrow (int graphics_stack_id, +/* +int graphics_set_arrow ( + int graphics_stack_id, int arrows_nb, int space_X, int space_Y, @@ -475,5 +320,6 @@ int graphics_set_arrow (int graphics_stack_id, int site, int arrow_x, int arrow_y, - int arrow_z); - + int arrow_z + ); +*/ diff --git a/include/util.h b/include/util.h index b14a3b7..c10e924 100644 --- a/include/util.h +++ b/include/util.h @@ -38,7 +38,7 @@ char *util_read_file (char *filename); char *util_concat (const char *str, ...); -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ typedef struct pile { int value; /**< value phantom documentation */ @@ -54,8 +54,7 @@ int util_pile_length (pile *p); // renvoie le nombre d'éléments de la //------------------------------------------------------------------------------ -/** phantom documentation used to test the functioning of doxygen */ - +/** simplest element of a double-chained list */ typedef struct elem { int value; /**< *value phantom documentation */ struct elem *prev; /**< *prev phantom documentation */ @@ -63,13 +62,12 @@ typedef struct elem { } elem; -/** phantom documentation used to test the functioning of doxygen */ - +/** required to init the empty list */ typedef struct { elem *first; /**< *first phantom documentation */ elem *last; /**< *last phantom documentation */ -} dblist; // structure d'accès à la liste - // +} dblist; + void util_list_2x2_init (dblist *l); // initialisation void util_list_2x2_clear (dblist *l); // vide toute la liste void util_list_2x2_view (dblist l); // affiche les valeurs de toute la liste @@ -82,8 +80,7 @@ int util_list_2x2_length (dblist l); // renvoie le nombre d'él //------------------------------------------------------------------------------ -/** phantom documentation used to test the functioning of doxygen */ - +/** phantom documentation */ typedef struct slist { int value; /**< value phantom documentation */ struct slist *suiv; /**< *suiv phantom documentation */ @@ -104,63 +101,13 @@ void util_test_sorted_list(); // " " //------------------------------------------------------------------------------ -/** - * Look for stack entry and returns stack_id - * - * @param *container_widget generally the GtkBox that contains the GLArea - * - * @returns stack_id - */ long util_gl_get_stack(void *container_widget); - -/** - * Look for stack entry and returns stack_id - * - * @param *container_widget generally the GtkBox that contains the GLArea - * - * @returns stack_id - */ -long util_gl_is_util_ready(void *container_widget); - -/** - * Look for stack entry and initializes OpenGL for it - * - * @param *container_widget generally the GtkBox that contains the GLArea - * - * @returns bool true if success - */ bool util_gl_init_stack(void *container_widget, GError *error_buffer); - bool util_gl_shutdown_stack(void *container_widget, GError *error_buffer); - void util_gl_clean_stack_index(void); - -/** - * Look for stack entry and triggers OpenGL for drawing - * - * @param *container_widget generally the GtkBox that contains the GLArea - * - * @returns bool true if success - */ bool util_gl_render_stack(GtkWidget *container_widget); - bool util_gl_update_axis(GtkWidget *container_widget, int axis, int value); - -/** - * Look for every stack entry and shutdowns OpenGL for it - * - * @param void - * - * @returns bool true if success - */ void util_gl_shutdown_all_stacks(void); - -/** - * Creates a slider widget - * - * @param axis meaning which axis we're building (for label) - * - * @returns GtkWidget* pointer to the new widget - */ GtkWidget *create_axis_slider(int axis); +// long util_gl_is_util_ready(void *container_widget); diff --git a/src/graphics/draw.c b/src/graphics/draw.c index c954a12..546069d 100644 --- a/src/graphics/draw.c +++ b/src/graphics/draw.c @@ -33,21 +33,21 @@ /** * Writes values to describe a vertex at (x,y,z) intoq the vertex buffer * - * @param stack_id + * @param graphics_stack_id * @param x * @param y * @param z */ -void graphics_draw_vertex (const int stack_id, +void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z) { - //g_printerr("stack_id is %d\n", stack_id); - //g_printerr("stack_id is %d\n", stack_id); + //g_printerr("graphics_stack_id is %d\n", graphics_stack_id); + //g_printerr("graphics_stack_id is %d\n", graphics_stack_id); //g_printerr("graphic_stack is at %p\n", graphic_stack); - //g_printerr("graphic_stack[stack_id] is at %p\n", graphic_stack + stack_id); - volatile struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + //g_printerr("graphic_stack[graphics_stack_id] is at %p\n", graphic_stack + graphics_stack_id); + volatile struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO //g_printerr("Currently stack->buffer_vertex_origin @ %p\n", stack->buffer_vertex_origin); @@ -56,7 +56,7 @@ void graphics_draw_vertex (const int stack_id, graphics_stack->buffer_vertex_origin = g_realloc (graphics_stack->buffer_vertex_origin, (graphics_stack->buffer_vertex_size + 3) * sizeof(GLfloat)); - //print_stack(stack_id); + //print_stack(graphics_stack_id); graphics_stack->buffer_vertex_origin[graphics_stack->buffer_vertex_size + 0] = x; graphics_stack->buffer_vertex_origin[graphics_stack->buffer_vertex_size + 1] = y; @@ -66,19 +66,20 @@ void graphics_draw_vertex (const int stack_id, } /** - * Writes values to describe a color (r,g,b) into the color buffer + * Draws the color (r, g, b) associated to a vertex + * if (console) prints (r, g, b) values to console * - * @param stack_id - * @param r - * @param g - * @param b + * @param graphics_stack_id + * @param r + * @param g + * @param b */ -void graphics_draw_color (const int stack_id, +void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b) { - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO graphics_stack->buffer_colors_origin = g_realloc (graphics_stack->buffer_colors_origin, (graphics_stack->buffer_colors_size + 3) * sizeof(GLfloat)); @@ -95,15 +96,15 @@ void graphics_draw_color (const int stack_id, /** * Writes values to describe a line from a to b into the line buffer * - * @param stack_id + * @param graphics_stack_id * @param a * @param b */ -void graphics_draw_line (const int stack_id, +void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b) { - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO graphics_stack->buffer_lines_origin = g_realloc (graphics_stack->buffer_lines_origin, (graphics_stack->buffer_lines_size + 2) * sizeof(GLuint)); @@ -119,17 +120,17 @@ void graphics_draw_line (const int stack_id, /** * Writes values to describe an (a,b,c) plan (triangle) into the plan buffer * - * @param stack_id + * @param graphics_stack_id * @param a * @param b * @param c */ -void graphics_draw_plan (const int stack_id, +void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c) { - struct graphics_stack_t *stack = &graphics_stack[stack_id]; + struct graphics_stack_t *stack = &graphics_stack[graphics_stack_id]; graphics_stack->buffer_plans_origin = g_realloc (graphics_stack->buffer_plans_origin, (graphics_stack->buffer_plans_size + 3) * sizeof(GLuint)); @@ -146,16 +147,16 @@ void graphics_draw_plan (const int stack_id, /** * Draws the current buffer to a gl_area * - * @param stack_id + * @param graphics_stack_id * gl_area, ptr to the gl_area widget */ -void graphics_draw(const int stack_id) +void graphics_draw(const int graphics_stack_id) { - struct graphics_stack_t *stack = &graphics_stack[stack_id]; + struct graphics_stack_t *stack = &graphics_stack[graphics_stack_id]; g_printerr("[debug] graphics_draw() started\n"); - graphics_print_stack(stack_id); + graphics_print_stack(graphics_stack_id); GLint cur_viewport[4]; glGetIntegerv(GL_VIEWPORT, cur_viewport); diff --git a/src/graphics/grid.c b/src/graphics/grid.c index d671ced..2246852 100644 --- a/src/graphics/grid.c +++ b/src/graphics/grid.c @@ -28,7 +28,7 @@ #include "../../include/graphics.h" /** phantom documentation used to test the functioning of doxygen */ -int graphics_draw_space_ridges_vertex (const int stack_id, +int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, @@ -36,46 +36,56 @@ int graphics_draw_space_ridges_vertex (const int stack_id, { GLfloat max = fmax(x, y); max = fmax(max, z); - graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex - y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex - y / max, - z / max); - graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex - y / max, - z / max); - graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex + y / max, - z / max); - graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex - y / max, + z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex - y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex + y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex - y / max, + z / max); - graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex + y / max, - z / max); - graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex - y / max, + z / max); - graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex + y / max, + z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex + y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex - y / max, + z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex + y / max, + z / max); - graphics_draw_vertex (stack_id, offset_vertex + x / max, + y / max, + z / max); + graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, + y / max, + z / max); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); - graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); + graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f); return 8; } /** phantom documentation used to test the functioning of doxygen */ -int graphics_draw_space_ridges_lines (const int stack_id) +int graphics_draw_space_ridges_lines (const int graphics_stack_id) { - graphics_draw_line (stack_id, 0, 1); graphics_draw_line (stack_id, 7, 4); - graphics_draw_line (stack_id, 0, 2); graphics_draw_line (stack_id, 7, 5); - graphics_draw_line (stack_id, 0, 3); graphics_draw_line (stack_id, 7, 6); + graphics_draw_line (graphics_stack_id, 0, 1); graphics_draw_line (graphics_stack_id, 7, 4); + graphics_draw_line (graphics_stack_id, 0, 2); graphics_draw_line (graphics_stack_id, 7, 5); + graphics_draw_line (graphics_stack_id, 0, 3); graphics_draw_line (graphics_stack_id, 7, 6); - graphics_draw_line (stack_id, 1, 4); graphics_draw_line (stack_id, 2, 4); - graphics_draw_line (stack_id, 1, 5); graphics_draw_line (stack_id, 3, 5); - graphics_draw_line (stack_id, 2, 6); graphics_draw_line (stack_id, 3, 6); + graphics_draw_line (graphics_stack_id, 1, 4); graphics_draw_line (graphics_stack_id, 2, 4); + graphics_draw_line (graphics_stack_id, 1, 5); graphics_draw_line (graphics_stack_id, 3, 5); + graphics_draw_line (graphics_stack_id, 2, 6); graphics_draw_line (graphics_stack_id, 3, 6); return 12; } -/** phantom documentation used to test the functioning of doxygen */ -long graphics_draw_grids_on_space_faces_vertex (const int stack_id, + +/** + * Writes grid lines on space faces + * + * @param graphics_stack_id + * @param x + * @param y + * @param z + * + * @returns l + */ +long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z) @@ -84,53 +94,62 @@ long graphics_draw_grids_on_space_faces_vertex (const int stack_id, for (i = 1; i < x; i++) { - graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, - y / max, - z / max); - graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, - y / max, z / max); - graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, y / max, z / max); - graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, - y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, - y / max, z / max); + graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, y / max, z / max); + graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, y / max, - z / max); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); } /* offset_vertex += (x - 1) * 4; */ /* offset_colors += (x - 1) * 4; */ for (i = 1; i < y; i++) { - graphics_draw_vertex (stack_id, - x / max, (2 * i / y - 1) * y / max, - z / max); - graphics_draw_vertex (stack_id, - x / max, (2 * i / y - 1) * y / max, z / max); - graphics_draw_vertex (stack_id, x / max, (2 * i / y - 1) * y / max, z / max); - graphics_draw_vertex (stack_id, x / max, (2 * i / y - 1) * y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, - x / max, (2 * i / y - 1) * y / max, - z / max); + graphics_draw_vertex (graphics_stack_id, - x / max, (2 * i / y - 1) * y / max, z / max); + graphics_draw_vertex (graphics_stack_id, x / max, (2 * i / y - 1) * y / max, z / max); + graphics_draw_vertex (graphics_stack_id, x / max, (2 * i / y - 1) * y / max, - z / max); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); } /* offset_vertex += (y - 1) * 4; */ /* offset_colors += (y - 1) * 4; */ for (i = 1; i < z; i++) { - graphics_draw_vertex (stack_id, - x / max, - y / max, (2 * i / z - 1) * z / max); - graphics_draw_vertex (stack_id, - x / max, y / max, (2 * i / z - 1) * z / max); - graphics_draw_vertex (stack_id, x / max, y / max, (2 * i / z - 1) * z / max); - graphics_draw_vertex (stack_id, x / max, - y / max, (2 * i / z - 1) * z / max); + graphics_draw_vertex (graphics_stack_id, - x / max, - y / max, (2 * i / z - 1) * z / max); + graphics_draw_vertex (graphics_stack_id, - x / max, y / max, (2 * i / z - 1) * z / max); + graphics_draw_vertex (graphics_stack_id, x / max, y / max, (2 * i / z - 1) * z / max); + graphics_draw_vertex (graphics_stack_id, x / max, - y / max, (2 * i / z - 1) * z / max); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); - graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); + graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f); } return (x + y + z - 3) * 3; } -/** phantom documentation used to test the functioning of doxygen */ -long graphics_draw_grids_on_space_faces_lines (const int stack_id, + +/** + * @param graphics_stack_id + * @param offset_vertex + * @param x + * @param y + * @param z + * + * @returns l + */ +long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, @@ -140,24 +159,24 @@ long graphics_draw_grids_on_space_faces_lines (const int stack_id, for (int i = 0; i < x - 1; i ++) { - graphics_draw_line (stack_id, offset_vertex + i * 4 + 1, offset_vertex + i * 4 + 2); - graphics_draw_line (stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 1, offset_vertex + i * 4 + 2); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3); } offset_vertex += (x - 1) * 4; for (int i = 0; i < y - 1; i ++) { - graphics_draw_line (stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3); - graphics_draw_line (stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0); } offset_vertex += (y - 1) * 4; for (int i = 0; i < z - 1; i ++) { - graphics_draw_line (stack_id, offset_vertex + i * 4 + 0, offset_vertex + i * 4 + 1); - graphics_draw_line (stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 0, offset_vertex + i * 4 + 1); + graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0); } return (x + y + z - 3) * 4; diff --git a/src/graphics/init.c b/src/graphics/init.c index afc0a06..265800b 100644 --- a/src/graphics/init.c +++ b/src/graphics/init.c @@ -103,7 +103,7 @@ static void graphics_debug_callback(GLenum source, GLenum type, GLuint id, /** * Initializes a gl_area * - * @param *error_buffer + * param *error_buffer < DO NOT DOCUMENT (it's 'void') * * @returns true if initialized */ @@ -167,13 +167,11 @@ int graphics_init(void *error_buffer) * @param id * @param *error_buffer * - * gl_area, ptr to the gl_area widget - * - * @return true if success + * @return success */ bool graphics_shutdown(const int id, void *error_buffer) { - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO if (id >= graphics_stack_size || graphics_stack_size == 0 || @@ -230,13 +228,13 @@ bool graphics_shutdown(const int id, void *error_buffer) * Attention, les vertex centraux de chaque unité d'espace (cube) * peuvent être redondants (max 6) * - * @param stack_id + * @param graphics_stack_id */ -void graphics_model_setup (const int stack_id) +void graphics_model_setup (const int graphics_stack_id) { /* I N I T I A L D A T A S P E C I F I C A T I O N */ - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO char dimension; long space_X; long space_Y; @@ -284,10 +282,10 @@ void graphics_model_setup (const int stack_id) /* S P A C E D R A W I N G */ - graphics_draw_space_ridges_vertex (stack_id, graphics_stack->buffer_vertex_size, space_X, space_Y, space_Z); - graphics_draw_space_ridges_lines (stack_id); - graphics_draw_grids_on_space_faces_vertex (stack_id, space_X, space_Y, space_Z); - graphics_draw_grids_on_space_faces_lines (stack_id, graphics_stack->buffer_lines_size, space_X, space_Y, space_Z); + graphics_draw_space_ridges_vertex (graphics_stack_id, graphics_stack->buffer_vertex_size, space_X, space_Y, space_Z); + graphics_draw_space_ridges_lines (graphics_stack_id); + graphics_draw_grids_on_space_faces_vertex (graphics_stack_id, space_X, space_Y, space_Z); + graphics_draw_grids_on_space_faces_lines (graphics_stack_id, graphics_stack->buffer_lines_size, space_X, space_Y, space_Z); graphics_stack->buffer_vertex_0_arrow = graphics_stack->buffer_vertex_size; graphics_stack->buffer_colors_0_arrow = graphics_stack->buffer_colors_size; @@ -308,7 +306,7 @@ void graphics_model_setup (const int stack_id) while (parse_model_get_next_arrow(&arrow, (char *)&state_id, dimension)) { g_print("[GRAPH DEBUG] cur arrow has x = %d\n", arrow.x); - graphics_stack->arrows_nb = graphics_set_arrow (stack_id, + graphics_stack->arrows_nb = graphics_set_arrow (graphics_stack_id, graphics_stack->arrows_nb, space_X, space_Y, @@ -328,16 +326,16 @@ void graphics_model_setup (const int stack_id) /** Initializes the buffer of a gl_area * Calls according to the user preferences * - * @param stack_id + * @param graphics_stack_id * * gl_area, ptr to the gl_area widget */ -void graphics_init_buffers(const int stack_id) +void graphics_init_buffers(const int graphics_stack_id) { - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO //XXX - graphics_model_setup(stack_id); + graphics_model_setup(graphics_stack_id); GLuint vao, vertex_buffer, color_buffer; @@ -372,15 +370,13 @@ void graphics_init_buffers(const int stack_id) /** * Initializes the shaders of a gl_area and link them to a program * - * @param stack_id + * @param graphics_stack_id * - * gl_area, ptr to the gl_area widget - * - * @return true if initialized + * @return initialized */ -bool graphics_init_shaders(const int stack_id) +bool graphics_init_shaders(const int graphics_stack_id) { - struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO + struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO char *vertex_shader; char *fragment_shader; int status; @@ -394,7 +390,7 @@ bool graphics_init_shaders(const int stack_id) vertex_shader = util_read_file(VERTEX_SHADER_FILE); if (vertex_shader == NULL) return false; - vertex = graphics_create_shader(stack_id, GL_VERTEX_SHADER, vertex_shader); + vertex = graphics_create_shader(graphics_stack_id, GL_VERTEX_SHADER, vertex_shader); if(vertex == 0) { graphics_stack->program = 0; @@ -406,7 +402,7 @@ bool graphics_init_shaders(const int stack_id) fragment_shader = util_read_file(FRAG_SHADER_FILE); if (fragment_shader == NULL) return false; - fragment = graphics_create_shader(stack_id, GL_FRAGMENT_SHADER, fragment_shader); + fragment = graphics_create_shader(graphics_stack_id, GL_FRAGMENT_SHADER, fragment_shader); if(fragment == 0) { glDeleteShader(vertex); diff --git a/src/util/draw/gl.c b/src/util/draw/gl.c index 8f36ded..30b3f06 100644 --- a/src/util/draw/gl.c +++ b/src/util/draw/gl.c @@ -1,6 +1,6 @@ /** * @file - * graphics - general drawing functions + * general drawing functions * * This file is part of Gem-graph. * @@ -86,11 +86,11 @@ int util_gl_set_arrow (int stack_id, // 2024-06-27 DEBUG ! /** - * Look for stack entry and returns stack_id + * Look for stack entry and returns stack_id * - * @param *container_widget + * @param *container_widget * - * @returns stack_id + * @returns stack_id */ long util_gl_get_stack(void *container_widget) { @@ -157,10 +157,10 @@ bool util_gl_init_stack (void *container_widget, GError *error_buffer) /** * Look for stack entry and shutdowns OpenGL for it * - * @param *container_widget: generally the GtkBox that contains the GLArea + * @param *container_widget * @param *error_buffer * - * @returns bool: true if success + * @returns success */ bool util_gl_shutdown_stack(void *container_widget, GError *error_buffer) { @@ -236,8 +236,9 @@ bool util_gl_update_axis(GtkWidget *container_widget, int axis, int value) /** * Look for every stack entry and shutdowns OpenGL for it * - * @details returns true if success ? - * TODO why not bool ? + * DO NOT DOCUMENT param void < argument 'void' of command @ param is not found + * + * DO NOT DOCUMENT returns bool true if success < does not return anything */ void util_gl_shutdown_all_stacks(void) { @@ -251,9 +252,9 @@ void util_gl_shutdown_all_stacks(void) /** * Creates a slider widget * - * @param axis + * @param axis meaning which axis we're building (for label) * - * @returns GtkWidget * + * @returns GtkWidget* pointer to the new widget */ GtkWidget *create_axis_slider(int axis) { diff --git a/src/util/io.c b/src/util/io.c index 8dc14cf..0c10db8 100644 --- a/src/util/io.c +++ b/src/util/io.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client util input output + * input output * * This file is part of Gem-graph. * diff --git a/src/util/list_2x2.c b/src/util/list_2x2.c index 0c42b25..ccfa42a 100644 --- a/src/util/list_2x2.c +++ b/src/util/list_2x2.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client util double_chained list + * double_chained list * * This file is part of Gem-graph. * diff --git a/src/util/parse.c b/src/util/parse.c index 9f474c4..766734d 100644 --- a/src/util/parse.c +++ b/src/util/parse.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client parsing functions. + * parsing XML * * This file is part of Gem-graph. * diff --git a/src/util/pile.c b/src/util/pile.c index 2f714cf..4abf835 100644 --- a/src/util/pile.c +++ b/src/util/pile.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client. + * simple pile * * This file is part of Gem-graph. It implements a simple pile functions. * diff --git a/src/util/sorted_list.c b/src/util/sorted_list.c index f224f70..a6db925 100644 --- a/src/util/sorted_list.c +++ b/src/util/sorted_list.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client. + * simple sorted list * * This file is part of Gem-graph. It implements a simple sorted list functions. * diff --git a/src/util/strings_op.c b/src/util/strings_op.c index 656c470..3435274 100644 --- a/src/util/strings_op.c +++ b/src/util/strings_op.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client. + * concat * * This file is part of Gem-graph. * diff --git a/src/util/tests.c b/src/util/tests.c index 25afb58..b2543cb 100644 --- a/src/util/tests.c +++ b/src/util/tests.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client. + * use to check utilities * * This file is part of Gem-graph. It only groups various tests. * diff --git a/src/util/tree.c b/src/util/tree.c index 3b8a95c..fe86f74 100644 --- a/src/util/tree.c +++ b/src/util/tree.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client. Widget tree functions. + * tree functions * * This file is part of Gem-graph. * diff --git a/src/widget/main_window/designer.c b/src/widget/main_window/designer.c index d0ef237..80ea074 100644 --- a/src/widget/main_window/designer.c +++ b/src/widget/main_window/designer.c @@ -1,10 +1,14 @@ /** * @file - * main window + * builds ans present * * This file is part of Gem-graph. * - * Six pages can be displayed in the main window: + * ensure the titlebar and the pages are available and init them + * + * triggers assembly of the topbar and the default page + * + * six pages can be displayed in the main window: * - synth: an overview that presents the main elements of interest simultaneously * - state: a detailed view of the space, enabling it to be explored or modified * - measures presents all the measures available and those in progress