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

doxygen introducing the 'readme.dox' files in directories (trying to...😕️)

This commit is contained in:
Jean Sirmai 2024-10-27 17:50:40 +01:00
parent 287a05d081
commit f7951934db
Signed by: jean
GPG Key ID: FB3115C340E057E3
32 changed files with 761 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/archives/textes/2022-07-31 Quels sont les états possibles du client ? → doc/archives/texts/2022-07-31 Quels sont les états possibles du client ?
View File

0
doc/archives/textes/théorie Gem-graph.txt → doc/archives/texts/théorie Gem-graph.txt
View File

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

@ -30,17 +30,25 @@
<para>This file is part of Gem-graph. It contains only the <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function.</para> <para>This file is part of Gem-graph. It contains only the <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function.</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
<para>The <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function <emphasis role="bold">initialises</emphasis> the log, the finite state machine (fsm), the application and the windows and <emphasis role="bold">closes</emphasis> all the elements it opened before the end of program execution.</para> <para>The <link linkend="_main_8c_1a3c04138a5bfe5d72780bb7e82a18e627">main()</link> function <emphasis role="bold">initialises</emphasis> the log, the finite state machine (fsm), the application and the windows and <emphasis role="bold">closes</emphasis> all the elements it opened before the end of program execution.</para>
<para>By default, the main window opens on the overview page of the current model as specified in: src/widget/main_window/designer/widget_design_main_window().</para> <para>By default, the main window opens on the overview page of the current model as specified in: src/widget/main_window/designer/widget_design_main_window().</para>
<para>There are several <emphasis role="bold">types of organisation</emphasis> in src (sources):</para> <para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
<para>The widgets that give the windows their appearance are organised in a tree-like <emphasis>hierarchy</emphasis>.</para> <para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem> </listitem><listitem>
<para>The fsm (finite state machine), which controls the program&apos;s actions and indicates its state at all times, contains the following main <emphasis>sections</emphasis>:<itemizedlist> <para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem> <listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para> <para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem> </listitem><listitem>
@ -49,11 +57,15 @@
<para>apply user preferences</para> <para>apply user preferences</para>
</listitem><listitem> </listitem><listitem>
<para>indicate the desired state of windows and widgets</para> <para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist> </listitem></itemizedlist>
</para> </para>
</listitem><listitem>
<para>The other functions are those that manage graphics, callbacks, utilities and the log. They are called <emphasis>transversal</emphasis> because they must be easily accessed by all the preceding functions. They therefore remain at the root (src). </para> <para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</listitem></itemizedlist> </entry></row></tbody></tgroup></informaltable>
</para> </para>
</section> </section>
<section> <section>

20
doc/docbook/d2/d02/widget_2main__window_2topbar_2dispatch_8c.xml
View File

@ -122,6 +122,26 @@ Parameters</title>
<formalpara><title>Returns</title> <formalpara><title>Returns</title>
<para>topbar </para> <para>topbar </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>selected_page</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara> </formalpara>
</para> </para>
Here is the call graph for this function:<para> Here is the call graph for this function:<para>

43
doc/docbook/d3/d01/readme_8dox.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_readme_8dox" xml:lang="en-US">
<title>doc/readme.dox File Reference</title>
<indexterm><primary>doc/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client doc <link linkend="_readme_8dox">readme.dox</link> file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client doc <link linkend="_readme_8dox">readme.dox</link> file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

43
doc/docbook/d4/d06/readme__dox_8c.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_readme__dox_8c" xml:lang="en-US">
<title>src/widget/readme_dox.c File Reference</title>
<indexterm><primary>src/widget/readme_dox.c</primary></indexterm>
<para>
<para>Gem-graph-client widget readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client widget readme.dox file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

43
doc/docbook/d4/d08/doc_2readme_8dox.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_doc_2readme_8dox" xml:lang="en-US">
<title>doc/readme.dox File Reference</title>
<indexterm><primary>doc/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client doc readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client doc readme.dox file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

17
doc/docbook/d4/d09/src_2fsm_2readme_8dox.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_src_2fsm_2readme_8dox" xml:lang="en-US">
<title>src/fsm/readme.dox File Reference</title>
<indexterm><primary>src/fsm/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client fsm readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client fsm readme.dox file. </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

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

@ -156,6 +156,11 @@ Parameters</title>
<row> <row>
<entry>*header_bar</entry><entry> <entry>*header_bar</entry><entry>
<para></para> <para></para>
</entry>
</row>
<row>
<entry>selected_page</entry><entry>
<para></para>
</entry> </entry>
</row> </row>
</tbody> </tbody>

17
doc/docbook/d9/d06/fsm_2readme_8dox.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_fsm_2readme_8dox" xml:lang="en-US">
<title>src/fsm/readme.dox File Reference</title>
<indexterm><primary>src/fsm/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client fsm readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client fsm readme.dox file. </para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

43
doc/docbook/dc/d03/widget_2readme_8dox.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_2readme_8dox" xml:lang="en-US">
<title>src/widget/readme.dox File Reference</title>
<indexterm><primary>src/widget/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client widget readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client widget readme.dox file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

45
doc/docbook/dc/d0c/widget_2readme_8dox_8c.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_widget_2readme_8dox_8c" xml:lang="en-US">
<title>src/widget/readme.dox.c File Reference</title>
<indexterm><primary>src/widget/readme.dox.c</primary></indexterm>
<para>
<para>Gem-graph-client widget <link linkend="_readme_8dox">readme.dox</link> file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client widget <link linkend="_readme_8dox">readme.dox</link> file. </para>
<para>(the .c extension is just crap)</para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

2
doc/docbook/dd/d01/fsm_8h.xml
View File

@ -359,7 +359,7 @@ This graph shows which files directly or indirectly include this file:<para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'> <para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable> </entry></row></tbody></tgroup></informaltable>
</para> </para>
<section xml:id="_fsm_8h_1autotoc_md1"> <section xml:id="_fsm_8h_1autotoc_md2">
<title>J O U R N A L - M E T A - R U L E S</title> <title>J O U R N A L - M E T A - R U L E S</title>
<para>ref: sudo cat /var/log/messages</para> <para>ref: sudo cat /var/log/messages</para>

19
doc/docbook/de/d05/fsm_2readme_8dox_8c.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_fsm_2readme_8dox_8c" xml:lang="en-US">
<title>src/fsm/readme.dox.c File Reference</title>
<indexterm><primary>src/fsm/readme.dox.c</primary></indexterm>
<para>
<para>Gem-graph-client fsm <link linkend="_readme_8dox">readme.dox</link> file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client fsm <link linkend="_readme_8dox">readme.dox</link> file. </para>
<para>(the .c extension is just crap)</para>
<para>This file is part of Gem-graph. </para>
</section>
</section>

43
doc/docbook/de/d0e/src_2widget_2readme_8dox.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_src_2widget_2readme_8dox" xml:lang="en-US">
<title>src/widget/readme.dox File Reference</title>
<indexterm><primary>src/widget/readme.dox</primary></indexterm>
<para>
<para>Gem-graph-client widget readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client widget readme.dox file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

43
doc/docbook/de/d0f/readme_8dox_8c.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_readme_8dox_8c" xml:lang="en-US">
<title>src/widget/readme.dox.c File Reference</title>
<indexterm><primary>src/widget/readme.dox.c</primary></indexterm>
<para>
<para>Gem-graph-client widget readme.dox file. </para>
</para>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client widget readme.dox file. </para>
<para>This file is part of Gem-graph.</para>
<para>The code files are all located in the src (sources) directory (the headers in &apos;include&apos;). They are divided into several <emphasis role="bold">types of organisation</emphasis>:</para>
<para><itemizedlist>
<listitem>
<para><emphasis>hierarchical</emphasis>: the widgets that give the windows their appearance are organised in the form of a tree. Windows are the first level of depth. Next come the title bar and the pages designed to occupy the window space below the title bar. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images.</para>
</listitem><listitem>
<para><emphasis>list</emphasis>: the main <emphasis>sections</emphasis> of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :<orderedlist>
<listitem>
<para>execute or edit (managing the appropriate tools states in both cases)</para>
</listitem><listitem>
<para>measure, operate on data, prepare displayable results</para>
</listitem><listitem>
<para>apply user preferences</para>
</listitem><listitem>
<para>indicate the desired state of windows and widgets</para>
</listitem></orderedlist>
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections. All program actions depend on this state.</para>
</listitem><listitem>
<para><emphasis>transversal</emphasis>: the other functions that must be easily accessible by all the previous functions. They are therefore all located at the root. These are the functions that manage graphics, callbacks, utilities and the log.</para>
</listitem></itemizedlist>
</para>
<para><informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>
</entry></row></tbody></tgroup></informaltable>
</para>
</section>
</section>

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

@ -1816,6 +1816,26 @@ Parameters</title>
<formalpara><title>Returns</title> <formalpara><title>Returns</title>
<para>topbar </para> <para>topbar </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>selected_page</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara> </formalpara>
</para> </para>
Here is the call graph for this function:<para> Here is the call graph for this function:<para>
@ -2495,6 +2515,11 @@ Parameters</title>
<row> <row>
<entry>*header_bar</entry><entry> <entry>*header_bar</entry><entry>
<para></para> <para></para>
</entry>
</row>
<row>
<entry>selected_page</entry><entry>
<para></para>
</entry> </entry>
</row> </row>
</tbody> </tbody>

3
doc/docbook/index.xml
View File

@ -23,6 +23,7 @@
</chapter> </chapter>
<chapter> <chapter>
<title>File Documentation</title> <title>File Documentation</title>
<xi:include href="d3/d01/readme_8dox.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d7/d01/action_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d7/d01/action_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d3/d0a/base_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d3/d0a/base_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="dd/d01/fsm_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="dd/d01/fsm_8h.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@ -91,6 +92,8 @@
<xi:include href="d2/d0e/fsm_2results_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d2/d0e/fsm_2results_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d3/d09/widget_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d3/d09/widget_2manager_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="d5/d0a/modal_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="d5/d0a/modal_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="de/d05/fsm_2readme_8dox_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="dc/d0c/widget_2readme_8dox_8c.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter> </chapter>
<index/> <index/>
</book> </book>

4
doc/doxyfile
View File

@ -1008,9 +1008,13 @@ INPUT_FILE_ENCODING =
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.c \
*.h \ *.h \
*.dox \ # TODO
*.dox.c \ # don't know how to use dox! (so...)
*.frag \ *.frag \
*.vert \ *.vert \
INCLUDE += readme.dox
# The RECURSIVE tag can be used to specify whether or not subdirectories should # The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well. # be searched for input files as well.
# The default value is: NO. # The default value is: NO.

58
doc/readme.dox Normal file
View File

@ -0,0 +1,58 @@
/**
* @page
* @file
* Gem-graph-client doc readme.dox file. (the .c extension is just crap)
*
* This file is part of Gem-graph.
*
* The code files are all located in the src (sources) directory
* (the headers in 'include').
* They are divided into several **types of organisation**:
*
* - *hierarchical*: the widgets that give the windows their appearance are
* organised in the form of a tree.
* Windows are the first level of depth.
* Next come the title bar and the pages designed to occupy the window space
* below the title bar.
* Each of these pages has its own hierarchical structure: it can be divided
* into horizontal or vertical strips, which can themselves be divided in the
* same way, with varying levels of depth right down to the last boxes, which
* contain lists of widgets such as buttons, sliders or images.
*
* - *list*: the main *sections* of the fsm (finite state machine) constitute
* a list of at least four elements, each of which defines a set of possible
* states :
* -# execute or edit (managing the appropriate tools states in both cases)
* -# measure, operate on data, prepare displayable results
* -# apply user preferences
* -# indicate the desired state of windows and widgets
* .
* The state of the fsm is uniquely defined at all times by all the parameters
* listed in these sections. All program actions depend on this state.
*
* - *transversal*: the other functions that must be easily accessible by all
* the previous functions. They are therefore all located at the root.
* These are the functions that manage graphics, callbacks, utilities
* and the log.
*
* ---
*
* @cond LICENSE
* Copyright © 2021 Libre en Communs <contact@a-lec.org>
* Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
* Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* @endcond
*/

5
doc/rtfm/man3/dispatch.c.3
View File

@ -79,6 +79,11 @@ topbar (left, center, right)
topbar topbar
.RE .RE
.PP .PP
\fBParameters\fP
.RS 4
\fIselected_page\fP
.RE
.PP
.SH "Author" .SH "Author"
.PP .PP

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

@ -108,6 +108,8 @@ It is in the function: static void switch_state_rules_data() { switch (\fBfsm_ge
\fBParameters\fP \fBParameters\fP
.RS 4 .RS 4
\fI*header_bar\fP \fI*header_bar\fP
.br
\fIselected_page\fP
.RE .RE
.PP .PP

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

@ -27,28 +27,34 @@ Gem-graph-client main file\&.
This file is part of Gem-graph\&. It contains only the \fBmain()\fP function\&. This file is part of Gem-graph\&. It contains only the \fBmain()\fP function\&.
.PP .PP
.PP
.PP
The \fBmain()\fP function \fBinitialises\fP the log, the finite state machine (fsm), the application and the windows and \fBcloses\fP all the elements it opened before the end of program execution\&. The \fBmain()\fP function \fBinitialises\fP the log, the finite state machine (fsm), the application and the windows and \fBcloses\fP all the elements it opened before the end of program execution\&.
.PP .PP
By default, the main window opens on the overview page of the current model as specified in: src/widget/main_window/designer/widget_design_main_window()\&. By default, the main window opens on the overview page of the current model as specified in: src/widget/main_window/designer/widget_design_main_window()\&.
.PP .PP
There are several \fBtypes of organisation\fP in src (sources): .PP
.PP
The code files are all located in the src (sources) directory (the headers in 'include')\&. They are divided into several \fBtypes of organisation\fP:
.PP .PP
.IP "\(bu" 2 .IP "\(bu" 2
The widgets that give the windows their appearance are organised in a tree-like \fIhierarchy\fP\&. \fIhierarchical\fP: the widgets that give the windows their appearance are organised in the form of a tree\&. Windows are the first level of depth\&. Next come the title bar and the pages designed to occupy the window space below the title bar\&. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images\&.
.IP "\(bu" 2 .IP "\(bu" 2
The fsm (finite state machine), which controls the program's actions and indicates its state at all times, contains the following main \fIsections\fP: \fIlist\fP: the main \fIsections\fP of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :
.IP " \(bu" 4 .IP " 1." 6
execute or edit (managing the appropriate tools states in both cases) execute or edit (managing the appropriate tools states in both cases)
.IP " \(bu" 4 .IP " 2." 6
measure, operate on data, prepare displayable results measure, operate on data, prepare displayable results
.IP " \(bu" 4 .IP " 3." 6
apply user preferences apply user preferences
.IP " \(bu" 4 .IP " 4." 6
indicate the desired state of windows and widgets indicate the desired state of windows and widgets
.PP .PP
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections\&. All program actions depend on this state\&.
.IP "\(bu" 2 .IP "\(bu" 2
The other functions are those that manage graphics, callbacks, utilities and the log\&. They are called \fItransversal\fP because they must be easily accessed by all the preceding functions\&. They therefore remain at the root (src)\&. \fItransversal\fP: the other functions that must be easily accessible by all the previous functions\&. They are therefore all located at the root\&. These are the functions that manage graphics, callbacks, utilities and the log\&.
.PP
.PP
.PP .PP
.SH "Function Documentation" .SH "Function Documentation"

40
doc/rtfm/man3/readme.dox.3 Normal file
View File

@ -0,0 +1,40 @@
.TH "doc/readme.dox" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
doc/readme.dox \- Gem-graph-client doc \fBreadme\&.dox\fP file\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
Gem-graph-client doc \fBreadme\&.dox\fP file\&.
This file is part of Gem-graph\&.
.PP
The code files are all located in the src (sources) directory (the headers in 'include')\&. They are divided into several \fBtypes of organisation\fP:
.PP
.IP "\(bu" 2
\fIhierarchical\fP: the widgets that give the windows their appearance are organised in the form of a tree\&. Windows are the first level of depth\&. Next come the title bar and the pages designed to occupy the window space below the title bar\&. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images\&.
.IP "\(bu" 2
\fIlist\fP: the main \fIsections\fP of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :
.IP " 1." 6
execute or edit (managing the appropriate tools states in both cases)
.IP " 2." 6
measure, operate on data, prepare displayable results
.IP " 3." 6
apply user preferences
.IP " 4." 6
indicate the desired state of windows and widgets
.PP
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections\&. All program actions depend on this state\&.
.IP "\(bu" 2
\fItransversal\fP: the other functions that must be easily accessible by all the previous functions\&. They are therefore all located at the root\&. These are the functions that manage graphics, callbacks, utilities and the log\&.
.PP
.PP
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

42
doc/rtfm/man3/readme.dox.c.3 Normal file
View File

@ -0,0 +1,42 @@
.TH "src/widget/readme.dox.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/widget/readme.dox.c \- Gem-graph-client widget \fBreadme\&.dox\fP file\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
Gem-graph-client widget \fBreadme\&.dox\fP file\&.
(the \&.c extension is just crap)
.PP
This file is part of Gem-graph\&.
.PP
The code files are all located in the src (sources) directory (the headers in 'include')\&. They are divided into several \fBtypes of organisation\fP:
.PP
.IP "\(bu" 2
\fIhierarchical\fP: the widgets that give the windows their appearance are organised in the form of a tree\&. Windows are the first level of depth\&. Next come the title bar and the pages designed to occupy the window space below the title bar\&. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images\&.
.IP "\(bu" 2
\fIlist\fP: the main \fIsections\fP of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :
.IP " 1." 6
execute or edit (managing the appropriate tools states in both cases)
.IP " 2." 6
measure, operate on data, prepare displayable results
.IP " 3." 6
apply user preferences
.IP " 4." 6
indicate the desired state of windows and widgets
.PP
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections\&. All program actions depend on this state\&.
.IP "\(bu" 2
\fItransversal\fP: the other functions that must be easily accessible by all the previous functions\&. They are therefore all located at the root\&. These are the functions that manage graphics, callbacks, utilities and the log\&.
.PP
.PP
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

40
doc/rtfm/man3/readme_dox.c.3 Normal file
View File

@ -0,0 +1,40 @@
.TH "src/widget/readme_dox.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/widget/readme_dox.c \- Gem-graph-client widget readme\&.dox file\&.
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP
Gem-graph-client widget readme\&.dox file\&.
This file is part of Gem-graph\&.
.PP
The code files are all located in the src (sources) directory (the headers in 'include')\&. They are divided into several \fBtypes of organisation\fP:
.PP
.IP "\(bu" 2
\fIhierarchical\fP: the widgets that give the windows their appearance are organised in the form of a tree\&. Windows are the first level of depth\&. Next come the title bar and the pages designed to occupy the window space below the title bar\&. Each of these pages has its own hierarchical structure: it can be divided into horizontal or vertical strips, which can themselves be divided in the same way, with varying levels of depth right down to the last boxes, which contain lists of widgets such as buttons, sliders or images\&.
.IP "\(bu" 2
\fIlist\fP: the main \fIsections\fP of the fsm (finite state machine) constitute a list of at least four elements, each of which defines a set of possible states :
.IP " 1." 6
execute or edit (managing the appropriate tools states in both cases)
.IP " 2." 6
measure, operate on data, prepare displayable results
.IP " 3." 6
apply user preferences
.IP " 4." 6
indicate the desired state of windows and widgets
.PP
The state of the fsm is uniquely defined at all times by all the parameters listed in these sections\&. All program actions depend on this state\&.
.IP "\(bu" 2
\fItransversal\fP: the other functions that must be easily accessible by all the previous functions\&. They are therefore all located at the root\&. These are the functions that manage graphics, callbacks, utilities and the log\&.
.PP
.PP
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.

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

@ -1040,6 +1040,11 @@ time_box
topbar topbar
.RE .RE
.PP .PP
\fBParameters\fP
.RS 4
\fIselected_page\fP
.RE
.PP
.SS "void * widget_get_user_rules_tree ()" .SS "void * widget_get_user_rules_tree ()"
@ -1267,6 +1272,8 @@ It is in the function: static void switch_state_rules_data() { switch (\fBfsm_ge
\fBParameters\fP \fBParameters\fP
.RS 4 .RS 4
\fI*header_bar\fP \fI*header_bar\fP
.br
\fIselected_page\fP
.RE .RE
.PP .PP

26
src/fsm/readme.dox.c Normal file
View File

@ -0,0 +1,26 @@
/**
* @page
* @file
* Gem-graph-client fsm readme.dox file. (the .c extension is just crap)
*
* This file is part of Gem-graph.
*
* @cond LICENSE
* Copyright © 2021 Libre en Communs <contact@a-lec.org>
* Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
* Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* @endcond
*/

42
src/main.c
View File

@ -4,6 +4,8 @@
* *
* This file is part of Gem-graph. It contains only the main() function. * This file is part of Gem-graph. It contains only the main() function.
* *
* ---
*
* The main() function **initialises** the log, the finite state machine (fsm), * The main() function **initialises** the log, the finite state machine (fsm),
* the application and the windows and **closes** all the elements it opened * the application and the windows and **closes** all the elements it opened
* before the end of program execution. * before the end of program execution.
@ -11,23 +13,39 @@
* 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
* as specified in: src/widget/main_window/designer/widget_design_main_window(). * as specified in: src/widget/main_window/designer/widget_design_main_window().
* *
* There are several **types of organisation** in src (sources): * ---
* *
* - The widgets that give the windows their appearance are organised in a tree-like * The code files are all located in the src (sources) directory
* *hierarchy*. * (the headers in 'include').
* They are divided into several **types of organisation**:
* *
* - The fsm (finite state machine), which controls the program's actions and * - *hierarchical*: the widgets that give the windows their appearance are
* indicates its state at all times, contains the following main *sections*: * organised in the form of a tree.
* - execute or edit (managing the appropriate tools states in both cases) * Windows are the first level of depth.
* - measure, operate on data, prepare displayable results * Next come the title bar and the pages designed to occupy the window space
* - apply user preferences * below the title bar.
* - indicate the desired state of windows and widgets * Each of these pages has its own hierarchical structure: it can be divided
* into horizontal or vertical strips, which can themselves be divided in the
* same way, with varying levels of depth right down to the last boxes, which
* contain lists of widgets such as buttons, sliders or images.
*
* - *list*: the main *sections* of the fsm (finite state machine) constitute
* a list of at least four elements, each of which defines a set of possible
* states :
* -# execute or edit (managing the appropriate tools states in both cases)
* -# measure, operate on data, prepare displayable results
* -# apply user preferences
* -# indicate the desired state of windows and widgets
* . * .
* The state of the fsm is uniquely defined at all times by all the parameters
* listed in these sections. All program actions depend on this state.
* *
* - The other functions are those that manage graphics, callbacks, utilities * - *transversal*: the other functions that must be easily accessible by all
* the previous functions. They are therefore all located at the root.
* These are the functions that manage graphics, callbacks, utilities
* and the log. * and the log.
* 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>

1
src/widget/main_window/topbar/dispatch.c
View File

@ -39,6 +39,7 @@
* @param *app * @param *app
* *
* @returns topbar * @returns topbar
* @param selected_page
*/ */
GtkWidget *widget_get_topbar(GtkApplication *app, int selected_page) GtkWidget *widget_get_topbar(GtkApplication *app, int selected_page)
{ {

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

@ -71,6 +71,7 @@ const char *widget_get_btt_label_data() {return "results";}
* } * }
* *
* @param *header_bar * @param *header_bar
* @param selected_page
*/ */
void window_design_topbar_left (GtkWidget *header_bar, int selected_page) void window_design_topbar_left (GtkWidget *header_bar, int selected_page)
{ {

58
src/widget/readme.dox.c Normal file
View File

@ -0,0 +1,58 @@
/**
* @page
* @file
* Gem-graph-client widget readme.dox file. (the .c extension is just crap)
*
* This file is part of Gem-graph.
*
* The code files are all located in the src (sources) directory
* (the headers in 'include').
* They are divided into several **types of organisation**:
*
* - *hierarchical*: the widgets that give the windows their appearance are
* organised in the form of a tree.
* Windows are the first level of depth.
* Next come the title bar and the pages designed to occupy the window space
* below the title bar.
* Each of these pages has its own hierarchical structure: it can be divided
* into horizontal or vertical strips, which can themselves be divided in the
* same way, with varying levels of depth right down to the last boxes, which
* contain lists of widgets such as buttons, sliders or images.
*
* - *list*: the main *sections* of the fsm (finite state machine) constitute
* a list of at least four elements, each of which defines a set of possible
* states :
* -# execute or edit (managing the appropriate tools states in both cases)
* -# measure, operate on data, prepare displayable results
* -# apply user preferences
* -# indicate the desired state of windows and widgets
* .
* The state of the fsm is uniquely defined at all times by all the parameters
* listed in these sections. All program actions depend on this state.
*
* - *transversal*: the other functions that must be easily accessible by all
* the previous functions. They are therefore all located at the root.
* These are the functions that manage graphics, callbacks, utilities
* and the log.
*
* ---
*
* @cond LICENSE
* Copyright © 2021 Libre en Communs <contact@a-lec.org>
* Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
* Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* @endcond
*/