Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Various docs update
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Sun, 22 Dec 2019 17:32:36 +0000 (18:32 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Mon, 23 Dec 2019 16:53:09 +0000 (17:53 +0100)
commit63c219ee10cf464f95ad9888e0814439445b53f8
tree428acd6d4bddd8056fec9cd6ea2f132f4cbfda3a
parent872edfc797b0084bc83f5d5f7b2b4826371b52ba
Various docs update

- Change the introduction on Routing to make it more self-contained.
- Move the Routing part to a specific page, as it's an advanced topic about platforms.
- Fix the formating of some examples
- Fix the formating of \beginrst blocks in doxygen
- Document the <disk> tag a bit, as well as the filesystem plugin
- Remove the doc about storage from the doxygen doc to be converted

- Document Engine with autodoxy
- Document the C API of Engine and Actor

- Teach autodoxy to produce the doc of C functions (that don't have '::' in their name)
- Teach find_missing to rant about undocumented C functions
23 files changed:
doc/doxygen/platform.doc
docs/find-missing.py
docs/ignored_symbols
docs/source/Doxyfile
docs/source/Platform_Examples.rst
docs/source/Platform_Routing.rst [new file with mode: 0644]
docs/source/Plugins.rst
docs/source/XML_Reference.rst
docs/source/_ext/autodoxy.py
docs/source/app_s4u.rst
docs/source/index.rst
docs/source/platform.rst
docs/source/platform_howtos.rst
examples/README.rst
include/simgrid/actor.h
include/simgrid/engine.h
include/simgrid/plugins/file_system.h
include/simgrid/s4u/Actor.hpp
include/simgrid/s4u/Engine.hpp
src/plugins/file_system/s4u_FileSystem.cpp
src/plugins/host_energy.cpp
src/plugins/link_energy.cpp
src/plugins/vm/s4u_VirtualMachine.cpp