diff --git a/doc/2021-04 gg (scheme).JPG b/doc/2021-04 gg (scheme).JPG deleted file mode 100644 index a169973..0000000 Binary files a/doc/2021-04 gg (scheme).JPG and /dev/null differ diff --git a/doc/docbook/annotated.xml b/doc/docbook/annotated.xml index de4673c..d36b461 100644 --- a/doc/docbook/annotated.xml +++ b/doc/docbook/annotated.xml @@ -26,7 +26,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions:
  • Stack Phantom documentation stack_index_t -Phantom documentation used to test the functioning of doxygen +Phantom documentation TreeNode_t Phantom documentation used to test the functioning of doxygen diff --git a/doc/docbook/d0/d09/main_8c.xml b/doc/docbook/d0/d09/main_8c.xml index 7242b10..0e0b367 100644 --- a/doc/docbook/d0/d09/main_8c.xml +++ b/doc/docbook/d0/d09/main_8c.xml @@ -24,8 +24,14 @@ The main() function initialises the log, the finite state machine (fsm), the application and the windows and closes all the elements it opened before the end of program execution. By default, the main window opens on the overview page of the current model. See also src/widget/main_window/topbar/dispatch/widget_design_main_window() + +src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE - +There are several types of organisation in src (sources). + +The widgets that give the windows their appearance are organised in a tree-like hierarchy. The fsm (finite state machine), which controls the program's actions and indicates its state at all times, contains the following main sections: execution/editing, main view, measurements/results, preferences. + +The other functions are those that manage graphics and utilities. They are called "transversal" because they must be easily accessed by all the preceding functions. They therefore remain at the root (src).
    Function Documentation diff --git a/doc/docbook/d1/d04/tools__list_8c.xml b/doc/docbook/d1/d04/tools__list_8c.xml index 2d671a5..68251f8 100644 --- a/doc/docbook/d1/d04/tools__list_8c.xml +++ b/doc/docbook/d1/d04/tools__list_8c.xml @@ -4,7 +4,7 @@ src/fsm/measures/tools_list.c -Gem-graph-client fsm measures tools. +fsm measures lists tools (basic functions). #include <stdbool.h>#include <stdio.h>#include <stdlib.h>#include "../../../include/fsm.h" @@ -39,7 +39,7 @@
    Detailed Description -Gem-graph-client fsm measures tools. +fsm measures lists tools (basic 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 a29617a..d2e9af2 100644 --- a/doc/docbook/d2/d02/grid_8c.xml +++ b/doc/docbook/d2/d02/grid_8c.xml @@ -4,7 +4,7 @@ src/graphics/grid.c -graphics - grid/empty space drawing functions +grid/empty space drawing functions #include "../../include/graphics.h" @@ -29,7 +29,7 @@
    Detailed Description -graphics - grid/empty space drawing functions +grid/empty space drawing functions This file is part of Gem-graph.
    diff --git a/doc/docbook/d5/d02/data__list_8c.xml b/doc/docbook/d5/d02/data__list_8c.xml index 6a92518..4efa716 100644 --- a/doc/docbook/d5/d02/data__list_8c.xml +++ b/doc/docbook/d5/d02/data__list_8c.xml @@ -4,7 +4,7 @@ src/fsm/measures/data_list.c -Gem-graph-client available measures list (and current use) +a list of available measurements, including those currently in use #include <stdbool.h>#include <stdio.h>#include <stdlib.h>#include <math.h>#include "../../../include/fsm.h" @@ -27,7 +27,7 @@
    Detailed Description -Gem-graph-client available measures list (and current use) +a list of available measurements, including those currently in use This file is part of Gem-graph. An editable list of results is defined and maintained here. Some operations can be performed on them. ex : filter, concat, inverse, scale, correlate, etc. See also diff --git a/doc/docbook/d5/d03/left_8c.xml b/doc/docbook/d5/d03/left_8c.xml index 947f780..1e031d7 100644 --- a/doc/docbook/d5/d03/left_8c.xml +++ b/doc/docbook/d5/d03/left_8c.xml @@ -10,7 +10,7 @@ #include "../../../../include/base.h"#include "../../../../include/signal.h"#include "../../../../include/widget.h"#include "../../../../include/fsm.h" Macros - #define YOU_WANT_TO_START_ON_ANOTHER_PAGE   0 + #define WANT_TO_START_ON_ANOTHER_PAGE   0 default == SYNTH diff --git a/doc/docbook/d6/d09/draw_8c.xml b/doc/docbook/d6/d09/draw_8c.xml index 1d7d95b..91ebb9c 100644 --- a/doc/docbook/d6/d09/draw_8c.xml +++ b/doc/docbook/d6/d09/draw_8c.xml @@ -4,7 +4,7 @@ src/graphics/draw.c -graphics - general drawing functions +general drawing functions #include <cglm/cglm.h>#include "../../include/base.h"#include "../../include/graphics.h" @@ -35,7 +35,7 @@
    Detailed Description -graphics - general drawing functions +general drawing functions This file is part of Gem-graph.
    diff --git a/doc/docbook/d7/d02/structstack__index__t.xml b/doc/docbook/d7/d02/structstack__index__t.xml index 9879c91..25807c1 100644 --- a/doc/docbook/d7/d02/structstack__index__t.xml +++ b/doc/docbook/d7/d02/structstack__index__t.xml @@ -4,7 +4,7 @@ stack_index_t -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -27,7 +27,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: src/util/draw/gl.c
    diff --git a/doc/docbook/d8/d00/init_8c.xml b/doc/docbook/d8/d00/init_8c.xml index 259b873..af684c8 100644 --- a/doc/docbook/d8/d00/init_8c.xml +++ b/doc/docbook/d8/d00/init_8c.xml @@ -4,7 +4,7 @@ src/graphics/init.c -graphics - initialization and graphic stack management +initialization and graphic stack management #include "../../include/graphics.h"#include "../../include/parse.h"#include "../../include/util.h" @@ -65,7 +65,7 @@
    Detailed Description -graphics - initialization and graphic stack management +initialization and graphic stack management 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 e4e2d57..2acd797 100644 --- a/doc/docbook/d8/d0c/util_8h.xml +++ b/doc/docbook/d8/d0c/util_8h.xml @@ -138,7 +138,7 @@     void util_gl_clean_stack_index (void) -phantom documentation used to test the functioning of doxygen +phantom documentation bool util_gl_render_stack (GtkWidget *container_widget) diff --git a/doc/docbook/da/d0c/gl_8c.xml b/doc/docbook/da/d0c/gl_8c.xml index e948fb1..8f79a90 100644 --- a/doc/docbook/da/d0c/gl_8c.xml +++ b/doc/docbook/da/d0c/gl_8c.xml @@ -12,7 +12,7 @@ struct stack_index_t -phantom documentation used to test the functioning of doxygen +phantom documentation     @@ -21,7 +21,7 @@ #define GL_AREA_SIZE   400 -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -50,7 +50,7 @@ void util_gl_clean_stack_index (void) -phantom documentation used to test the functioning of doxygen +phantom documentation bool util_gl_render_stack (GtkWidget *container_widget) @@ -70,7 +70,7 @@ bool util_gl_setup_glarea (int target_mode, GtkWidget *target_widget) -phantom documentation used to test the functioning of doxygen +phantom documentation @@ -79,7 +79,7 @@ size_t stack_index_size = 0 -phantom documentation used to test the functioning of doxygen +phantom documentation diff --git a/doc/docbook/db/d07/assign_8c.xml b/doc/docbook/db/d07/assign_8c.xml index 13b9dc5..4c6fec8 100644 --- a/doc/docbook/db/d07/assign_8c.xml +++ b/doc/docbook/db/d07/assign_8c.xml @@ -10,7 +10,7 @@ #include "../../../../../include/fsm.h"#include "../../../../../include/widget.h"#include "../../../../../include/signal.h"#include <stdio.h>#include <stdlib.h> Functions - void * widget_get_selected_rule_assignations_list_btt () + void * widget_get_selected_rule_assignments_list_btt () Presents the list of all the elementary actions (assignments) performed when the rule is applied. @@ -25,11 +25,11 @@
    Function Documentation -
    - widget_get_selected_rule_assignations_list_btt() -widget_get_selected_rule_assignations_list_bttassign.c -assign.cwidget_get_selected_rule_assignations_list_btt -void * widget_get_selected_rule_assignations_list_btt ( ) +
    + widget_get_selected_rule_assignments_list_btt() +widget_get_selected_rule_assignments_list_bttassign.c +assign.cwidget_get_selected_rule_assignments_list_btt +void * widget_get_selected_rule_assignments_list_btt ( ) Presents the list of all the elementary actions (assignments) performed when the rule is applied. diff --git a/doc/docbook/dc/d0b/disp__list_8c.xml b/doc/docbook/dc/d0b/disp__list_8c.xml index dd8c054..189a52e 100644 --- a/doc/docbook/dc/d0b/disp__list_8c.xml +++ b/doc/docbook/dc/d0b/disp__list_8c.xml @@ -4,7 +4,7 @@ src/fsm/measures/disp_list.c -Gem-graph-client displayable results list (and current use) +a list of displayable results, including those currently displayed Gem-graph-client list (and current use) #include <stdbool.h>#include <stdio.h>#include <stdlib.h>#include "../../../include/fsm.h" @@ -21,7 +21,7 @@
    Detailed Description -Gem-graph-client displayable results list (and current use) +a list of displayable results, including those currently displayed Gem-graph-client list (and current use) This file is part of Gem-graph. An editable list of results is defined and maintained here. Some operations can be performed on them. ex : filter, concat, inverse, scale, correlate, etc. See also diff --git a/doc/docbook/df/d05/widget_8h.xml b/doc/docbook/df/d05/widget_8h.xml index a3e33f7..bf8332f 100644 --- a/doc/docbook/df/d05/widget_8h.xml +++ b/doc/docbook/df/d05/widget_8h.xml @@ -270,7 +270,7 @@ Builds and presents the conditions list of a rule. - void * widget_get_selected_rule_assignations_list_btt () + void * widget_get_selected_rule_assignments_list_btt () Presents the list of all the elementary actions (assignments) performed when the rule is applied. @@ -728,11 +728,11 @@ Parameters
    -
    - widget_get_selected_rule_assignations_list_btt() -widget_get_selected_rule_assignations_list_bttwidget.h -widget.hwidget_get_selected_rule_assignations_list_btt -void * widget_get_selected_rule_assignations_list_btt ( ) +
    + widget_get_selected_rule_assignments_list_btt() +widget_get_selected_rule_assignments_list_bttwidget.h +widget.hwidget_get_selected_rule_assignments_list_btt +void * widget_get_selected_rule_assignments_list_btt ( ) Presents the list of all the elementary actions (assignments) performed when the rule is applied. diff --git a/doc/docbook/logo icon.png b/doc/docbook/logo icon.png index 0f217e2..e1e357c 100644 Binary files a/doc/docbook/logo icon.png and b/doc/docbook/logo icon.png differ diff --git a/doc/doxyfile b/doc/doxyfile index 3e1f6b0..1bb958b 100644 --- a/doc/doxyfile +++ b/doc/doxyfile @@ -84,7 +84,7 @@ PROJECT_BRIEF = A modelling tool based on rewriting of geometric graphs # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ./doc/logo icon mini.png +PROJECT_LOGO = ./doc/logo icon.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/doc/gg_calligraphie.png b/doc/gg_calligraphie.png deleted file mode 100644 index f707101..0000000 Binary files a/doc/gg_calligraphie.png and /dev/null differ diff --git a/doc/logo icon mini.png b/doc/logo icon mini.png deleted file mode 100644 index e1e357c..0000000 Binary files a/doc/logo icon mini.png and /dev/null differ diff --git a/doc/logo icon.png b/doc/logo icon.png index 0f217e2..e1e357c 100644 Binary files a/doc/logo icon.png and b/doc/logo icon.png differ diff --git a/doc/logo.png b/doc/logo.png deleted file mode 100644 index 02a0909..0000000 Binary files a/doc/logo.png and /dev/null differ diff --git a/doc/rtfm/man3/assign.c.3 b/doc/rtfm/man3/assign.c.3 index 7301223..a682d50 100644 --- a/doc/rtfm/man3/assign.c.3 +++ b/doc/rtfm/man3/assign.c.3 @@ -22,7 +22,7 @@ src/widget/main_window/one_rule/algebra/assign.c \- Algebra of rule actions\&. .in +1c .ti -1c -.RI "void * \fBwidget_get_selected_rule_assignations_list_btt\fP ()" +.RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()" .br .RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .in -1c @@ -33,7 +33,7 @@ Algebra of rule actions\&. This file is part of Gem-graph\&. It hosts the functions needed to describe a rule effect\&. .SH "Function Documentation" .PP -.SS "void * widget_get_selected_rule_assignations_list_btt ()" +.SS "void * widget_get_selected_rule_assignments_list_btt ()" .PP Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO diff --git a/doc/rtfm/man3/data_list.c.3 b/doc/rtfm/man3/data_list.c.3 index 85f30f4..6538b90 100644 --- a/doc/rtfm/man3/data_list.c.3 +++ b/doc/rtfm/man3/data_list.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/fsm/measures/data_list.c \- Gem-graph-client available measures list (and current use) +src/fsm/measures/data_list.c \- a list of available measurements, including those currently in use .SH SYNOPSIS .br @@ -36,7 +36,7 @@ src/fsm/measures/data_list.c \- Gem-graph-client available measures list (and cu .in -1c .SH "Detailed Description" .PP -Gem-graph-client available measures list (and current use) +a list of available measurements, including those currently in use This file is part of Gem-graph\&. An editable list of results is defined and maintained here\&. Some operations can be performed on them\&. ex : filter, concat, inverse, scale, correlate, etc\&. .PP diff --git a/doc/rtfm/man3/disp_list.c.3 b/doc/rtfm/man3/disp_list.c.3 index 42f1669..438c721 100644 --- a/doc/rtfm/man3/disp_list.c.3 +++ b/doc/rtfm/man3/disp_list.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/fsm/measures/disp_list.c \- Gem-graph-client displayable results list (and current use) +src/fsm/measures/disp_list.c \- a list of displayable results, including those currently displayed Gem-graph-client list (and current use) .SH SYNOPSIS .br @@ -31,7 +31,7 @@ src/fsm/measures/disp_list.c \- Gem-graph-client displayable results list (and c .in -1c .SH "Detailed Description" .PP -Gem-graph-client displayable results list (and current use) +a list of displayable results, including those currently displayed Gem-graph-client list (and current use) This file is part of Gem-graph\&. An editable list of results is defined and maintained here\&. Some operations can be performed on them\&. ex : filter, concat, inverse, scale, correlate, etc\&. .PP diff --git a/doc/rtfm/man3/draw.c.3 b/doc/rtfm/man3/draw.c.3 index c25afaa..88e8c7f 100644 --- a/doc/rtfm/man3/draw.c.3 +++ b/doc/rtfm/man3/draw.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/graphics/draw.c \- graphics - general drawing functions +src/graphics/draw.c \- general drawing functions .SH SYNOPSIS .br @@ -40,7 +40,7 @@ src/graphics/draw.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" diff --git a/doc/rtfm/man3/gl.c.3 b/doc/rtfm/man3/gl.c.3 index d3bbe1d..bdc7941 100644 --- a/doc/rtfm/man3/gl.c.3 +++ b/doc/rtfm/man3/gl.c.3 @@ -18,7 +18,7 @@ src/util/draw/gl.c \- general drawing functions .ti -1c .RI "struct \fBstack_index_t\fP" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SS "Macros" @@ -26,7 +26,7 @@ src/util/draw/gl.c \- general drawing functions .ti -1c .RI "#define \fBGL_AREA_SIZE\fP 400" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SS "Functions" @@ -54,7 +54,7 @@ src/util/draw/gl.c \- general drawing functions .ti -1c .RI "void \fButil_gl_clean_stack_index\fP (void)" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .ti -1c .RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)" .br @@ -74,7 +74,7 @@ src/util/draw/gl.c \- general drawing functions .ti -1c .RI "bool \fButil_gl_setup_glarea\fP (int target_mode, GtkWidget *target_widget)" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SS "Variables" @@ -82,7 +82,7 @@ src/util/draw/gl.c \- general drawing functions .ti -1c .RI "size_t \fBstack_index_size\fP = 0" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .in -1c .SH "Detailed Description" .PP diff --git a/doc/rtfm/man3/grid.c.3 b/doc/rtfm/man3/grid.c.3 index 6dcf686..2c6b07b 100644 --- a/doc/rtfm/man3/grid.c.3 +++ b/doc/rtfm/man3/grid.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/graphics/grid.c \- graphics - grid/empty space drawing functions +src/graphics/grid.c \- grid/empty space drawing functions .SH SYNOPSIS .br @@ -31,7 +31,7 @@ src/graphics/grid.c \- graphics - grid/empty space drawing functions .in -1c .SH "Detailed Description" .PP -graphics - grid/empty space drawing functions +grid/empty space drawing functions This file is part of Gem-graph\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/init.c.3 b/doc/rtfm/man3/init.c.3 index 5de1653..a447737 100644 --- a/doc/rtfm/man3/init.c.3 +++ b/doc/rtfm/man3/init.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/graphics/init.c \- graphics - initialization and graphic stack management +src/graphics/init.c \- initialization and graphic stack management .SH SYNOPSIS .br @@ -68,7 +68,7 @@ src/graphics/init.c \- graphics - initialization and graphic stack management .in -1c .SH "Detailed Description" .PP -graphics - initialization and graphic stack management +initialization and graphic stack management This file is part of Gem-graph\&. .SH "Function Documentation" diff --git a/doc/rtfm/man3/left.c.3 b/doc/rtfm/man3/left.c.3 index 42e79e3..67bd86f 100644 --- a/doc/rtfm/man3/left.c.3 +++ b/doc/rtfm/man3/left.c.3 @@ -20,7 +20,7 @@ src/widget/main_window/topbar/left.c \- Topbar left\&. .in +1c .ti -1c -.RI "#define \fBYOU_WANT_TO_START_ON_ANOTHER_PAGE\fP 0" +.RI "#define \fBWANT_TO_START_ON_ANOTHER_PAGE\fP 0" .br .RI "default == SYNTH " .in -1c diff --git a/doc/rtfm/man3/main.c.3 b/doc/rtfm/man3/main.c.3 index e147461..cad3f41 100644 --- a/doc/rtfm/man3/main.c.3 +++ b/doc/rtfm/man3/main.c.3 @@ -32,9 +32,15 @@ The \fBmain()\fP function initialises the log, the finite state machine (fsm), t \fBSee also\fP .RS 4 src/widget/main_window/topbar/dispatch/widget_design_main_window() +.PP +src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE .RE .PP - +There are several types of organisation in src (sources)\&. +.PP +The widgets that give the windows their appearance are organised in a tree-like hierarchy\&. The fsm (finite state machine), which controls the program's actions and indicates its state at all times, contains the following main sections: execution/editing, main view, measurements/results, preferences\&. +.PP +The other functions are those that manage graphics and utilities\&. They are called 'transversal' because they must be easily accessed by all the preceding functions\&. They therefore remain at the root (src)\&. .SH "Function Documentation" .PP .SS "int main (int argc, char ** argv)" diff --git a/doc/rtfm/man3/stack_index_t.3 b/doc/rtfm/man3/stack_index_t.3 index 18e0994..a6cef58 100644 --- a/doc/rtfm/man3/stack_index_t.3 +++ b/doc/rtfm/man3/stack_index_t.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -stack_index_t \- phantom documentation used to test the functioning of doxygen +stack_index_t \- phantom documentation .SH SYNOPSIS .br @@ -25,7 +25,7 @@ stack_index_t \- 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/tools_list.c.3 b/doc/rtfm/man3/tools_list.c.3 index 9508b89..15af3cf 100644 --- a/doc/rtfm/man3/tools_list.c.3 +++ b/doc/rtfm/man3/tools_list.c.3 @@ -2,7 +2,7 @@ .ad l .nh .SH NAME -src/fsm/measures/tools_list.c \- Gem-graph-client fsm measures tools\&. +src/fsm/measures/tools_list.c \- fsm measures lists tools (basic functions)\&. .SH SYNOPSIS .br @@ -46,7 +46,7 @@ src/fsm/measures/tools_list.c \- Gem-graph-client fsm measures tools\&. .in -1c .SH "Detailed Description" .PP -Gem-graph-client fsm measures tools\&. +fsm measures lists tools (basic functions)\&. This file is part of Gem-graph\&. .SH "Author" diff --git a/doc/rtfm/man3/util.h.3 b/doc/rtfm/man3/util.h.3 index 7b1a8c7..afd1cf4 100644 --- a/doc/rtfm/man3/util.h.3 +++ b/doc/rtfm/man3/util.h.3 @@ -156,7 +156,7 @@ include/util.h \- utilities header .ti -1c .RI "void \fButil_gl_clean_stack_index\fP (void)" .br -.RI "phantom documentation used to test the functioning of doxygen " +.RI "phantom documentation " .ti -1c .RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)" .br diff --git a/doc/rtfm/man3/widget.h.3 b/doc/rtfm/man3/widget.h.3 index f23c292..593bd07 100644 --- a/doc/rtfm/man3/widget.h.3 +++ b/doc/rtfm/man3/widget.h.3 @@ -281,7 +281,7 @@ include/widget.h \- widgets hierarchy header .br .RI "Builds and presents the conditions list of a rule\&. " .ti -1c -.RI "void * \fBwidget_get_selected_rule_assignations_list_btt\fP ()" +.RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()" .br .RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .ti -1c @@ -602,7 +602,7 @@ src/widget/one_rule/dispatch() .RE .PP -.SS "void * widget_get_selected_rule_assignations_list_btt ()" +.SS "void * widget_get_selected_rule_assignments_list_btt ()" .PP Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. Today, an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules\&. (see below) TODO diff --git a/include/widget.h b/include/widget.h index 0124ada..304cd99 100644 --- a/include/widget.h +++ b/include/widget.h @@ -218,7 +218,7 @@ void *widget_get_rule_investigation_tools(); // one_rule/geometry/investigate void *widget_get_selected_rule_algebra(); void *widget_get_selected_rule_geometry(); void *widget_get_selected_rule_conditions_list_btt(); -void *widget_get_selected_rule_assignations_list_btt(); +void *widget_get_selected_rule_assignments_list_btt(); void *widget_get_selected_rule_identity_btt(); // def: widget / rules / selected / wip_menu.c diff --git a/src/fsm/measures/data_list.c b/src/fsm/measures/data_list.c index c9e8264..d03f4ac 100644 --- a/src/fsm/measures/data_list.c +++ b/src/fsm/measures/data_list.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client available measures list (and current use) + * a list of available measurements, including those currently in use * * This file is part of Gem-graph. An editable list of results is defined and * maintained here. Some operations can be performed on them. diff --git a/src/fsm/measures/disp_list.c b/src/fsm/measures/disp_list.c index 08d102c..9531e98 100644 --- a/src/fsm/measures/disp_list.c +++ b/src/fsm/measures/disp_list.c @@ -1,6 +1,7 @@ /** * @file - * Gem-graph-client displayable results list (and current use) + * a list of displayable results, including those currently displayed + * Gem-graph-client list (and current use) * * This file is part of Gem-graph. An editable list of results is defined and * maintained here. Some operations can be performed on them. diff --git a/src/fsm/measures/tools_list.c b/src/fsm/measures/tools_list.c index af2708f..6558a42 100644 --- a/src/fsm/measures/tools_list.c +++ b/src/fsm/measures/tools_list.c @@ -1,6 +1,6 @@ /** * @file - * Gem-graph-client fsm measures tools. + * fsm measures lists tools (basic functions). * * This file is part of Gem-graph. * diff --git a/src/graphics/draw.c b/src/graphics/draw.c index 546069d..cecd956 100644 --- a/src/graphics/draw.c +++ b/src/graphics/draw.c @@ -1,6 +1,6 @@ /** * @file - * graphics - general drawing functions + * general drawing functions * * This file is part of Gem-graph. * diff --git a/src/graphics/grid.c b/src/graphics/grid.c index 2246852..77e2793 100644 --- a/src/graphics/grid.c +++ b/src/graphics/grid.c @@ -1,6 +1,6 @@ /** * @file - * graphics - grid/empty space drawing functions + * grid/empty space drawing functions * * This file is part of Gem-graph. * diff --git a/src/graphics/init.c b/src/graphics/init.c index 265800b..787684a 100644 --- a/src/graphics/init.c +++ b/src/graphics/init.c @@ -1,6 +1,6 @@ /** * @file - * graphics - initialization and graphic stack management + * initialization and graphic stack management * * This file is part of Gem-graph. * diff --git a/src/main.c b/src/main.c index 32999d3..2f2effc 100644 --- a/src/main.c +++ b/src/main.c @@ -9,6 +9,19 @@ * before the end of program execution. * By default, the main window opens on the overview page of the current model. * @see src/widget/main_window/topbar/dispatch/widget_design_main_window() + * @see src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE + * + *There are several types of organisation in src (sources). + * + * The widgets that give the windows their appearance are organised in a tree-like + * hierarchy. + * The fsm (finite state machine), which controls the program's actions and + * indicates its state at all times, contains the following main sections: + * execution/editing, main view, measurements/results, preferences. + * + * The other functions are those that manage graphics and utilities. + * They are called "transversal" because they must be easily accessed by all the + * preceding functions. They therefore remain at the root (src). * * @cond LICENSE * Copyright © 2021 Libre en Communs diff --git a/src/util/draw/gl.c b/src/util/draw/gl.c index 30b3f06..1142468 100644 --- a/src/util/draw/gl.c +++ b/src/util/draw/gl.c @@ -31,11 +31,11 @@ #include "../../../include/graphics.h" #include "../../../include/signal.h" -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ #define GL_AREA_SIZE 400 -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ struct stack_index_t { long stack_id; /**< stack_id phantom documentation */ @@ -43,11 +43,11 @@ struct stack_index_t { void *gl_area; /**< gl_area phantom documentation */ }; -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ static struct stack_index_t *stack_index = NULL; -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ size_t stack_index_size = 0; @@ -179,7 +179,7 @@ bool util_gl_shutdown_stack(void *container_widget, GError *error_buffer) } -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ void util_gl_clean_stack_index(void) { @@ -397,7 +397,7 @@ on_render_debug (GtkGLArea *area, GdkGLContext *context) return TRUE; } -/** phantom documentation used to test the functioning of doxygen */ +/** phantom documentation */ bool util_gl_setup_glarea (int target_mode, GtkWidget *target_widget) { diff --git a/src/widget/main_window/one_rule/algebra/assign.c b/src/widget/main_window/one_rule/algebra/assign.c index d78462f..412f515 100644 --- a/src/widget/main_window/one_rule/algebra/assign.c +++ b/src/widget/main_window/one_rule/algebra/assign.c @@ -59,7 +59,7 @@ * * @return the assignations list */ -void *widget_get_selected_rule_assignations_list_btt() +void *widget_get_selected_rule_assignments_list_btt() { GtkWidget *list_box = gtk_list_box_new(); GtkWidget *scrolled_list_box = GTK_WIDGET (gtk_scrolled_window_new ()); diff --git a/src/widget/main_window/one_rule/algebra/dispatch.c b/src/widget/main_window/one_rule/algebra/dispatch.c index 90157f0..c98ba07 100644 --- a/src/widget/main_window/one_rule/algebra/dispatch.c +++ b/src/widget/main_window/one_rule/algebra/dispatch.c @@ -67,7 +67,7 @@ void *widget_get_selected_rule_algebra() gtk_box_append (conditions_actions_names_box, GTK_WIDGET (widget_get_selected_rule_conditions_list_btt ())); gtk_box_append (conditions_actions_names_box, - GTK_WIDGET (widget_get_selected_rule_assignations_list_btt())); + GTK_WIDGET (widget_get_selected_rule_assignments_list_btt())); gtk_box_append (conditions_actions_names_box, GTK_WIDGET (widget_get_selected_rule_identity_btt())); diff --git a/src/widget/main_window/topbar/left.c b/src/widget/main_window/topbar/left.c index acd77da..12d9d6c 100644 --- a/src/widget/main_window/topbar/left.c +++ b/src/widget/main_window/topbar/left.c @@ -29,7 +29,7 @@ #include "../../../../include/widget.h" #include "../../../../include/fsm.h" -#define YOU_WANT_TO_START_ON_ANOTHER_PAGE 0 /**< default == SYNTH */ +#define WANT_TO_START_ON_ANOTHER_PAGE 0 /**< default == SYNTH */ /******************************************************************************/ /* M A I N W I N D O W T O P B A R ( L E F T ) */ @@ -121,7 +121,7 @@ void window_design_topbar_left (GtkWidget *header_bar) /* the last one is the winner (and the winner takes it all !...) */ /* THE LAST ONE IS THE WINNER (AND THE WINNER TAKES IT ALL !...) */ /******************************************************************************/ - if (YOU_WANT_TO_START_ON_ANOTHER_PAGE) { // select one + if (WANT_TO_START_ON_ANOTHER_PAGE) { // select one gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_SYNTH), TRUE); gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_STATE), TRUE); gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_RULES), TRUE);