This commit is the first in a series that will make the fsm apt to build the
log.
The log (or journal) records events chronologically from the start to the end of the programme. Its quantitatively most important part is to report on the execution of the session.
The log will be created from the fsm (finite state machine) which describes all the possible states of the Gem-graph client and all the transitions between them.
The fsm header is introduced in this commit.
It lists the structures, functions and tools that the log will need and details the presentation of events in the log [date - rank - source file - source function - value].
The src/readme.docs file provides an initial overview of the missions and their distribution in the code files.
valgrind --show-leak-kinds=all bin/gem-graph-client shows always the same message:
==xxxx== LEAK SUMMARY:
==xxxx== definitely lost: 96 bytes in 1 blocks
==xxxx== indirectly lost: 64 bytes in 1 blocks
==xxxx== possibly lost: 2,627 bytes in 7 blocks
We wanted to have an automated documentation for our project. We choose doxygen
since this is a well-established project, with common standards.
To generate the documentation, simply type `make docs` and open `docs/html/index.html`.
The documentation zone actually contains:
- archives: several files from past of the projects, historical purpose
- GTK-docs: ressources on GTK internals and API
- rtfm: first draft of a user manual
- showcase: some pictures of the UI example, that were communicated on the Gem-graph discussion room (XMPP)
- html: doxygen-generated docs
Jean Sirmai
