gem-graph-client/doc/rtfm/man3/main.c.3

77 lines
1.9 KiB
Groff
Raw Normal View History

.TH "src/main.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/main.c \- Gem-graph-client main file\&.
.SH SYNOPSIS
.br
.PP
\fC#include '\&.\&./include/fsm\&.h'\fP
.br
\fC#include '\&.\&./include/signal\&.h'\fP
.br
\fC#include '\&.\&./include/widget\&.h'\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "int \fBmain\fP (int argc, char **argv)"
.br
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client main file\&.
This file is part of Gem-graph\&. It contains only the \fBmain()\fP function\&.
.PP
The \fBmain()\fP 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\&.
.PP
\fBSee also\fP
.RS 4
src/widget/main_window/topbar/dispatch/widget_design_main_window()
.PP
src/widget/main_window/topbar/left/WANT_TO_START_ON_ANOTHER_PAGE
.RE
.PP
There are several types of organisation in src (sources)\&.
.PP
The widgets that give the windows their appearance are organised in a tree-like hierarchy\&. The fsm (finite state machine), which controls the program's actions and indicates its state at all times, contains the following main sections: execution/editing, main view, measurements/results, preferences\&.
.PP
The other functions are those that manage graphics and utilities\&. They are called 'transversal' because they must be easily accessed by all the preceding functions\&. They therefore remain at the root (src)\&.
.SH "Function Documentation"
.PP
.SS "int main (int argc, char ** argv)"
.PP
\fBSince\fP
.RS 4
2024-04
.RE
.PP
\fBSee also\fP
.RS 4
src/fsm/dispatch/fsm_init()
.PP
src/widget/dispatch/on_windows_activation(app)
.RE
.PP
\fBParameters\fP
.RS 4
\fIargc\fP
.br
\fI**argv\fP
.RE
.PP
\fBReturns\fP
.RS 4
status, the program errorlevel
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.