gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity

doygen (WIP) + manual (WIP @see doc/rtfm/Once upon a time,) 

et un premier commit avec titre + détails 🙂️
This commit is contained in:
Jean Sirmai 2024-10-24 09:12:19 +02:00
parent 31e8e0b2e2
commit 16e777ed1a
Signed by: jean
GPG Key ID: FB3115C340E057E3
46 changed files with 105 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/2021-04 gg (scheme).JPG
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 7.2 MiB

2
doc/docbook/annotated.xml
View File

@ -26,7 +26,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions:<li
<link linkend="_structStack">Stack</link> <link linkend="_structStack">Stack</link>
<para>Phantom documentation </para> <para>Phantom documentation </para>
<link linkend="_structstack__index__t">stack_index_t</link> <link linkend="_structstack__index__t">stack_index_t</link>
<para>Phantom documentation used to test the functioning of doxygen </para> <para>Phantom documentation </para>
<link linkend="_structTreeNode__t">TreeNode_t</link> <link linkend="_structTreeNode__t">TreeNode_t</link>
<para>Phantom documentation used to test the functioning of doxygen </para> <para>Phantom documentation used to test the functioning of doxygen </para>
</section> </section>

8
doc/docbook/d0/d09/main_8c.xml
View File

@ -24,8 +24,14 @@
<para>The <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> 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. <formalpara><title>See also</title> <para>The <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> 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. <formalpara><title>See also</title>
<para>src/widget/main_window/topbar/dispatch/widget_design_main_window() </para> <para>src/widget/main_window/topbar/dispatch/widget_design_main_window() </para>
<para>src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE</para>
</formalpara> </formalpara>
</para> There are several types of organisation in src (sources).</para>
<para>The widgets that give the windows their appearance are organised in a tree-like hierarchy. The fsm (finite state machine), which controls the program&apos;s actions and indicates its state at all times, contains the following main sections: execution/editing, main view, measurements/results, preferences.</para>
<para>The other functions are those that manage graphics and utilities. They are called &quot;transversal&quot; because they must be easily accessed by all the preceding functions. They therefore remain at the root (src). </para>
</section> </section>
<section> <section>
<title>Function Documentation</title> <title>Function Documentation</title>

4
doc/docbook/d1/d04/tools__list_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/fsm/measures/tools_list.c</primary></indexterm> <indexterm><primary>src/fsm/measures/tools_list.c</primary></indexterm>
<para> <para>
<para>Gem-graph-client fsm measures tools. </para> <para>fsm measures lists tools (basic functions). </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -39,7 +39,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>Gem-graph-client fsm measures tools. </para> <para>fsm measures lists tools (basic functions). </para>
<para>This file is part of Gem-graph. </para> <para>This file is part of Gem-graph. </para>
</section> </section>

4
doc/docbook/d2/d02/grid_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/graphics/grid.c</primary></indexterm> <indexterm><primary>src/graphics/grid.c</primary></indexterm>
<para> <para>
<para>graphics - grid/empty space drawing functions </para> <para>grid/empty space drawing functions </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
@ -29,7 +29,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>graphics - grid/empty space drawing functions </para> <para>grid/empty space drawing functions </para>
<para>This file is part of Gem-graph. </para> <para>This file is part of Gem-graph. </para>
</section> </section>

4
doc/docbook/d5/d02/data__list_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/fsm/measures/data_list.c</primary></indexterm> <indexterm><primary>src/fsm/measures/data_list.c</primary></indexterm>
<para> <para>
<para>Gem-graph-client available measures list (and current use) </para> <para>a list of available measurements, including those currently in use </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;math.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;math.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -27,7 +27,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>Gem-graph-client available measures list (and current use) </para> <para>a list of available measurements, including those currently in use </para>
<para>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. <formalpara><title>See also</title> <para>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. <formalpara><title>See also</title>

2
doc/docbook/d5/d03/left_8c.xml
View File

@ -10,7 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &quot;../../../../include/base.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
<title>Macros </title> <title>Macros </title>
<itemizedlist> <itemizedlist>
<listitem><para><anchor xml:id="_left_8c_1a1f11849629657b36a7a936043e1790ca"/>#define <emphasis role="strong">YOU_WANT_TO_START_ON_ANOTHER_PAGE</emphasis>&#160;&#160;&#160;0</para> <listitem><para><anchor xml:id="_left_8c_1a570930b5f05abce00f0655fee5972eba"/>#define <emphasis role="strong">WANT_TO_START_ON_ANOTHER_PAGE</emphasis>&#160;&#160;&#160;0</para>
<para>default == SYNTH </para> <para>default == SYNTH </para>
</listitem> </listitem>

4
doc/docbook/d6/d09/draw_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/graphics/draw.c</primary></indexterm> <indexterm><primary>src/graphics/draw.c</primary></indexterm>
<para> <para>
<para>graphics - general drawing functions </para> <para>general drawing functions </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &lt;cglm/cglm.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?>#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &lt;cglm/cglm.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?>#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
@ -35,7 +35,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>graphics - general drawing functions </para> <para>general drawing functions </para>
<para>This file is part of Gem-graph. </para> <para>This file is part of Gem-graph. </para>
</section> </section>

4
doc/docbook/d7/d02/structstack__index__t.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>stack_index_t</primary></indexterm> <indexterm><primary>stack_index_t</primary></indexterm>
<para> <para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</para> </para>
<simplesect> <simplesect>
@ -27,7 +27,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
<para> <para>
The documentation for this struct was generated from the following file:</para> The documentation for this struct was generated from the following file:</para>
src/util/draw/<link linkend="_gl_8c">gl.c</link></section> src/util/draw/<link linkend="_gl_8c">gl.c</link></section>

4
doc/docbook/d8/d00/init_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/graphics/init.c</primary></indexterm> <indexterm><primary>src/graphics/init.c</primary></indexterm>
<para> <para>
<para>graphics - initialization and graphic stack management </para> <para>initialization and graphic stack management </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?>#include &quot;../../include/parse.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?>#include &quot;../../include/parse.h&quot;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -65,7 +65,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>graphics - initialization and graphic stack management </para> <para>initialization and graphic stack management </para>
<para>This file is part of Gem-graph. </para> <para>This file is part of Gem-graph. </para>
</section> </section>

2
doc/docbook/d8/d0c/util_8h.xml
View File

@ -138,7 +138,7 @@
</listitem> </listitem>
<listitem><para><anchor xml:id="_util_8h_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para> <listitem><para><anchor xml:id="_util_8h_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
<listitem><para>bool <link linkend="_util_8h_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para> <listitem><para>bool <link linkend="_util_8h_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para>

10
doc/docbook/da/d0c/gl_8c.xml
View File

@ -12,7 +12,7 @@
<itemizedlist> <itemizedlist>
<listitem><para>struct <link linkend="_structstack__index__t">stack_index_t</link></para> <listitem><para>struct <link linkend="_structstack__index__t">stack_index_t</link></para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</simplesect> </simplesect>
@ -21,7 +21,7 @@
<itemizedlist> <itemizedlist>
<listitem><para><anchor xml:id="_gl_8c_1a2737fdf992bd5a9d008f620ddaf50107"/>#define <emphasis role="strong">GL_AREA_SIZE</emphasis>&#160;&#160;&#160;400</para> <listitem><para><anchor xml:id="_gl_8c_1a2737fdf992bd5a9d008f620ddaf50107"/>#define <emphasis role="strong">GL_AREA_SIZE</emphasis>&#160;&#160;&#160;400</para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</simplesect> </simplesect>
@ -50,7 +50,7 @@
</listitem> </listitem>
<listitem><para><anchor xml:id="_gl_8c_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para> <listitem><para><anchor xml:id="_gl_8c_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
<listitem><para>bool <link linkend="_gl_8c_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para> <listitem><para>bool <link linkend="_gl_8c_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para>
@ -70,7 +70,7 @@
</listitem> </listitem>
<listitem><para><anchor xml:id="_gl_8c_1ac90dc30613c94fdefedb76cf6d2c4ac8"/>bool <emphasis role="strong">util_gl_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para> <listitem><para><anchor xml:id="_gl_8c_1ac90dc30613c94fdefedb76cf6d2c4ac8"/>bool <emphasis role="strong">util_gl_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</simplesect> </simplesect>
@ -79,7 +79,7 @@
<itemizedlist> <itemizedlist>
<listitem><para><anchor xml:id="_gl_8c_1a176a1af12ef0fb33a5de5cd36ef7145a"/>size_t <emphasis role="strong">stack_index_size</emphasis> = 0</para> <listitem><para><anchor xml:id="_gl_8c_1a176a1af12ef0fb33a5de5cd36ef7145a"/>size_t <emphasis role="strong">stack_index_size</emphasis> = 0</para>
<para>phantom documentation used to test the functioning of doxygen </para> <para>phantom documentation </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</simplesect> </simplesect>

12
doc/docbook/db/d07/assign_8c.xml
View File

@ -10,7 +10,7 @@
<programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &quot;../../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../../include/signal.h&quot;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?></programlisting><simplesect>
<title>Functions </title> <title>Functions </title>
<itemizedlist> <itemizedlist>
<listitem><para>void * <link linkend="_assign_8c_1a118c74f398c9e46f2a2252deaf88337e">widget_get_selected_rule_assignations_list_btt</link> ()</para> <listitem><para>void * <link linkend="_assign_8c_1a9020593f4cd1b7f9dd85dd383523474c">widget_get_selected_rule_assignments_list_btt</link> ()</para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para> <para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</listitem> </listitem>
@ -25,11 +25,11 @@
</section> </section>
<section> <section>
<title>Function Documentation</title> <title>Function Documentation</title>
<anchor xml:id="_assign_8c_1a118c74f398c9e46f2a2252deaf88337e"/><section> <anchor xml:id="_assign_8c_1a9020593f4cd1b7f9dd85dd383523474c"/><section>
<title>widget_get_selected_rule_assignations_list_btt()</title> <title>widget_get_selected_rule_assignments_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_assignations_list_btt</primary><secondary>assign.c</secondary></indexterm> <indexterm><primary>widget_get_selected_rule_assignments_list_btt</primary><secondary>assign.c</secondary></indexterm>
<indexterm><primary>assign.c</primary><secondary>widget_get_selected_rule_assignations_list_btt</secondary></indexterm> <indexterm><primary>assign.c</primary><secondary>widget_get_selected_rule_assignments_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_assignations_list_btt ( )</computeroutput></para><para> <para><computeroutput>void * widget_get_selected_rule_assignments_list_btt ( )</computeroutput></para><para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para> <para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</para> </para>

4
doc/docbook/dc/d0b/disp__list_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/fsm/measures/disp_list.c</primary></indexterm> <indexterm><primary>src/fsm/measures/disp_list.c</primary></indexterm>
<para> <para>
<para>Gem-graph-client displayable results list (and current use) </para> <para>a list of displayable results, including those currently displayed Gem-graph-client list (and current use) </para>
</para> </para>
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect> <programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -21,7 +21,7 @@
<section> <section>
<title>Detailed Description</title> <title>Detailed Description</title>
<para>Gem-graph-client displayable results list (and current use) </para> <para>a list of displayable results, including those currently displayed Gem-graph-client list (and current use) </para>
<para>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. <formalpara><title>See also</title> <para>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. <formalpara><title>See also</title>

12
doc/docbook/df/d05/widget_8h.xml
View File

@ -270,7 +270,7 @@
<para>Builds and presents the conditions list of a rule. </para> <para>Builds and presents the conditions list of a rule. </para>
</listitem> </listitem>
<listitem><para>void * <link linkend="_widget_8h_1a118c74f398c9e46f2a2252deaf88337e">widget_get_selected_rule_assignations_list_btt</link> ()</para> <listitem><para>void * <link linkend="_widget_8h_1a9020593f4cd1b7f9dd85dd383523474c">widget_get_selected_rule_assignments_list_btt</link> ()</para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para> <para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</listitem> </listitem>
@ -728,11 +728,11 @@ Parameters</title>
</formalpara> </formalpara>
</para> </para>
</section> </section>
<anchor xml:id="_widget_8h_1a118c74f398c9e46f2a2252deaf88337e"/><section> <anchor xml:id="_widget_8h_1a9020593f4cd1b7f9dd85dd383523474c"/><section>
<title>widget_get_selected_rule_assignations_list_btt()</title> <title>widget_get_selected_rule_assignments_list_btt()</title>
<indexterm><primary>widget_get_selected_rule_assignations_list_btt</primary><secondary>widget.h</secondary></indexterm> <indexterm><primary>widget_get_selected_rule_assignments_list_btt</primary><secondary>widget.h</secondary></indexterm>
<indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_assignations_list_btt</secondary></indexterm> <indexterm><primary>widget.h</primary><secondary>widget_get_selected_rule_assignments_list_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_assignations_list_btt ( )</computeroutput></para><para> <para><computeroutput>void * widget_get_selected_rule_assignments_list_btt ( )</computeroutput></para><para>
<para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para> <para>Presents the list of all the elementary actions (assignments) performed when the rule is applied. </para>
</para> </para>

BIN
doc/docbook/logo icon.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

2
doc/doxyfile
View File

@ -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 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory. # 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 # 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 # into which the generated documentation will be written. If a relative path is

BIN
doc/gg_calligraphie.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 6.5 KiB

BIN
doc/logo icon mini.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 3.4 KiB

BIN
doc/logo icon.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

BIN
doc/logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 53 KiB

4
doc/rtfm/man3/assign.c.3
View File

@ -22,7 +22,7 @@ src/widget/main_window/one_rule/algebra/assign.c \- Algebra of rule actions\&.
.in +1c .in +1c
.ti -1c .ti -1c
.RI "void * \fBwidget_get_selected_rule_assignations_list_btt\fP ()" .RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()"
.br .br
.RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. "
.in -1c .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\&. This file is part of Gem-graph\&. It hosts the functions needed to describe a rule effect\&.
.SH "Function Documentation" .SH "Function Documentation"
.PP .PP
.SS "void * widget_get_selected_rule_assignations_list_btt ()" .SS "void * widget_get_selected_rule_assignments_list_btt ()"
.PP .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 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

4
doc/rtfm/man3/data_list.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .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 .SH SYNOPSIS
.br .br
@ -36,7 +36,7 @@ src/fsm/measures/data_list.c \- Gem-graph-client available measures list (and cu
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .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\&. 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 .PP

4
doc/rtfm/man3/disp_list.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .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 .SH SYNOPSIS
.br .br
@ -31,7 +31,7 @@ src/fsm/measures/disp_list.c \- Gem-graph-client displayable results list (and c
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .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\&. 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 .PP

4
doc/rtfm/man3/draw.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
src/graphics/draw.c \- graphics - general drawing functions src/graphics/draw.c \- general drawing functions
.SH SYNOPSIS .SH SYNOPSIS
.br .br
@ -40,7 +40,7 @@ src/graphics/draw.c \- graphics - general drawing functions
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
graphics - general drawing functions general drawing functions
This file is part of Gem-graph\&. This file is part of Gem-graph\&.
.SH "Function Documentation" .SH "Function Documentation"

10
doc/rtfm/man3/gl.c.3
View File

@ -18,7 +18,7 @@ src/util/draw/gl.c \- general drawing functions
.ti -1c .ti -1c
.RI "struct \fBstack_index_t\fP" .RI "struct \fBstack_index_t\fP"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.in -1c .in -1c
.SS "Macros" .SS "Macros"
@ -26,7 +26,7 @@ src/util/draw/gl.c \- general drawing functions
.ti -1c .ti -1c
.RI "#define \fBGL_AREA_SIZE\fP 400" .RI "#define \fBGL_AREA_SIZE\fP 400"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.in -1c .in -1c
.SS "Functions" .SS "Functions"
@ -54,7 +54,7 @@ src/util/draw/gl.c \- general drawing functions
.ti -1c .ti -1c
.RI "void \fButil_gl_clean_stack_index\fP (void)" .RI "void \fButil_gl_clean_stack_index\fP (void)"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.ti -1c .ti -1c
.RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)" .RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)"
.br .br
@ -74,7 +74,7 @@ src/util/draw/gl.c \- general drawing functions
.ti -1c .ti -1c
.RI "bool \fButil_gl_setup_glarea\fP (int target_mode, GtkWidget *target_widget)" .RI "bool \fButil_gl_setup_glarea\fP (int target_mode, GtkWidget *target_widget)"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.in -1c .in -1c
.SS "Variables" .SS "Variables"
@ -82,7 +82,7 @@ src/util/draw/gl.c \- general drawing functions
.ti -1c .ti -1c
.RI "size_t \fBstack_index_size\fP = 0" .RI "size_t \fBstack_index_size\fP = 0"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP

4
doc/rtfm/man3/grid.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
src/graphics/grid.c \- graphics - grid/empty space drawing functions src/graphics/grid.c \- grid/empty space drawing functions
.SH SYNOPSIS .SH SYNOPSIS
.br .br
@ -31,7 +31,7 @@ src/graphics/grid.c \- graphics - grid/empty space drawing functions
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
graphics - grid/empty space drawing functions grid/empty space drawing functions
This file is part of Gem-graph\&. This file is part of Gem-graph\&.
.SH "Function Documentation" .SH "Function Documentation"

4
doc/rtfm/man3/init.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
src/graphics/init.c \- graphics - initialization and graphic stack management src/graphics/init.c \- initialization and graphic stack management
.SH SYNOPSIS .SH SYNOPSIS
.br .br
@ -68,7 +68,7 @@ src/graphics/init.c \- graphics - initialization and graphic stack management
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
graphics - initialization and graphic stack management initialization and graphic stack management
This file is part of Gem-graph\&. This file is part of Gem-graph\&.
.SH "Function Documentation" .SH "Function Documentation"

2
doc/rtfm/man3/left.c.3
View File

@ -20,7 +20,7 @@ src/widget/main_window/topbar/left.c \- Topbar left\&.
.in +1c .in +1c
.ti -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 .br
.RI "default == SYNTH " .RI "default == SYNTH "
.in -1c .in -1c

8
doc/rtfm/man3/main.c.3
View File

@ -32,9 +32,15 @@ The \fBmain()\fP function initialises the log, the finite state machine (fsm), t
\fBSee also\fP \fBSee also\fP
.RS 4 .RS 4
src/widget/main_window/topbar/dispatch/widget_design_main_window() src/widget/main_window/topbar/dispatch/widget_design_main_window()
.PP
src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE
.RE .RE
.PP .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" .SH "Function Documentation"
.PP .PP
.SS "int main (int argc, char ** argv)" .SS "int main (int argc, char ** argv)"

4
doc/rtfm/man3/stack_index_t.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .SH NAME
stack_index_t \- phantom documentation used to test the functioning of doxygen stack_index_t \- phantom documentation
.SH SYNOPSIS .SH SYNOPSIS
.br .br
@ -25,7 +25,7 @@ stack_index_t \- phantom documentation used to test the functioning of doxygen
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
phantom documentation used to test the functioning of doxygen phantom documentation
.SH "Author" .SH "Author"
.PP .PP

4
doc/rtfm/man3/tools_list.c.3
View File

@ -2,7 +2,7 @@
.ad l .ad l
.nh .nh
.SH NAME .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 .SH SYNOPSIS
.br .br
@ -46,7 +46,7 @@ src/fsm/measures/tools_list.c \- Gem-graph-client fsm measures tools\&.
.in -1c .in -1c
.SH "Detailed Description" .SH "Detailed Description"
.PP .PP
Gem-graph-client fsm measures tools\&. fsm measures lists tools (basic functions)\&.
This file is part of Gem-graph\&. This file is part of Gem-graph\&.
.SH "Author" .SH "Author"

2
doc/rtfm/man3/util.h.3
View File

@ -156,7 +156,7 @@ include/util.h \- utilities header
.ti -1c .ti -1c
.RI "void \fButil_gl_clean_stack_index\fP (void)" .RI "void \fButil_gl_clean_stack_index\fP (void)"
.br .br
.RI "phantom documentation used to test the functioning of doxygen " .RI "phantom documentation "
.ti -1c .ti -1c
.RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)" .RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)"
.br .br

4
doc/rtfm/man3/widget.h.3
View File

@ -281,7 +281,7 @@ include/widget.h \- widgets hierarchy header
.br .br
.RI "Builds and presents the conditions list of a rule\&. " .RI "Builds and presents the conditions list of a rule\&. "
.ti -1c .ti -1c
.RI "void * \fBwidget_get_selected_rule_assignations_list_btt\fP ()" .RI "void * \fBwidget_get_selected_rule_assignments_list_btt\fP ()"
.br .br
.RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. " .RI "Presents the list of all the elementary actions (assignments) performed when the rule is applied\&. "
.ti -1c .ti -1c
@ -602,7 +602,7 @@ src/widget/one_rule/dispatch()
.RE .RE
.PP .PP
.SS "void * widget_get_selected_rule_assignations_list_btt ()" .SS "void * widget_get_selected_rule_assignments_list_btt ()"
.PP .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 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

2
include/widget.h
View File

@ -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_algebra();
void *widget_get_selected_rule_geometry(); void *widget_get_selected_rule_geometry();
void *widget_get_selected_rule_conditions_list_btt(); 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(); void *widget_get_selected_rule_identity_btt();
// def: widget / rules / selected / wip_menu.c // def: widget / rules / selected / wip_menu.c

2
src/fsm/measures/data_list.c
View File

@ -1,6 +1,6 @@
/** /**
* @file * @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 * This file is part of Gem-graph. An editable list of results is defined and
* maintained here. Some operations can be performed on them. * maintained here. Some operations can be performed on them.

3
src/fsm/measures/disp_list.c
View File

@ -1,6 +1,7 @@
/** /**
* @file * @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 * This file is part of Gem-graph. An editable list of results is defined and
* maintained here. Some operations can be performed on them. * maintained here. Some operations can be performed on them.

2
src/fsm/measures/tools_list.c
View File

@ -1,6 +1,6 @@
/** /**
* @file * @file
* Gem-graph-client fsm measures tools. * fsm measures lists tools (basic functions).
* *
* This file is part of Gem-graph. * This file is part of Gem-graph.
* *

2
src/graphics/draw.c
View File

@ -1,6 +1,6 @@
/** /**
* @file * @file
* graphics - general drawing functions * general drawing functions
* *
* This file is part of Gem-graph. * This file is part of Gem-graph.
* *

2
src/graphics/grid.c
View File

@ -1,6 +1,6 @@
/** /**
* @file * @file
* graphics - grid/empty space drawing functions * grid/empty space drawing functions
* *
* This file is part of Gem-graph. * This file is part of Gem-graph.
* *

2
src/graphics/init.c
View File

@ -1,6 +1,6 @@
/** /**
* @file * @file
* graphics - initialization and graphic stack management * initialization and graphic stack management
* *
* This file is part of Gem-graph. * This file is part of Gem-graph.
* *

13
src/main.c
View File

@ -9,6 +9,19 @@
* before the end of program execution. * before the end of program execution.
* By default, the main window opens on the overview page of the current model. * 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/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 * @cond LICENSE
* Copyright © 2021 Libre en Communs <contact@a-lec.org> * Copyright © 2021 Libre en Communs <contact@a-lec.org>

12
src/util/draw/gl.c
View File

@ -31,11 +31,11 @@
#include "../../../include/graphics.h" #include "../../../include/graphics.h"
#include "../../../include/signal.h" #include "../../../include/signal.h"
/** phantom documentation used to test the functioning of doxygen */ /** phantom documentation */
#define GL_AREA_SIZE 400 #define GL_AREA_SIZE 400
/** phantom documentation used to test the functioning of doxygen */ /** phantom documentation */
struct stack_index_t { struct stack_index_t {
long stack_id; /**< stack_id phantom documentation */ long stack_id; /**< stack_id phantom documentation */
@ -43,11 +43,11 @@ struct stack_index_t {
void *gl_area; /**< gl_area phantom documentation */ 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; 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; 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) void util_gl_clean_stack_index(void)
{ {
@ -397,7 +397,7 @@ on_render_debug (GtkGLArea *area, GdkGLContext *context)
return TRUE; return TRUE;
} }
/** phantom documentation used to test the functioning of doxygen */ /** phantom documentation */
bool util_gl_setup_glarea (int target_mode, GtkWidget *target_widget) bool util_gl_setup_glarea (int target_mode, GtkWidget *target_widget)
{ {

2
src/widget/main_window/one_rule/algebra/assign.c
View File

@ -59,7 +59,7 @@
* *
* @return the assignations list * @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 *list_box = gtk_list_box_new();
GtkWidget *scrolled_list_box = GTK_WIDGET (gtk_scrolled_window_new ()); GtkWidget *scrolled_list_box = GTK_WIDGET (gtk_scrolled_window_new ());

2
src/widget/main_window/one_rule/algebra/dispatch.c
View File

@ -67,7 +67,7 @@ void *widget_get_selected_rule_algebra()
gtk_box_append (conditions_actions_names_box, gtk_box_append (conditions_actions_names_box,
GTK_WIDGET (widget_get_selected_rule_conditions_list_btt ())); GTK_WIDGET (widget_get_selected_rule_conditions_list_btt ()));
gtk_box_append (conditions_actions_names_box, 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_box_append (conditions_actions_names_box,
GTK_WIDGET (widget_get_selected_rule_identity_btt())); GTK_WIDGET (widget_get_selected_rule_identity_btt()));

4
src/widget/main_window/topbar/left.c
View File

@ -29,7 +29,7 @@
#include "../../../../include/widget.h" #include "../../../../include/widget.h"
#include "../../../../include/fsm.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 ) */ /* 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 !...) */
/* 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_SYNTH), TRUE);
gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_STATE), TRUE); gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_STATE), TRUE);
gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_RULES), TRUE); gtk_check_button_set_active (GTK_CHECK_BUTTON (btt_RULES), TRUE);