Fix another bunch of warnings in doc generation.

[simgrid.git] / docs / source / app_msg.rst

diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst
index daa47e1..082e64b 100644 (file)
--- a/docs/source/app_msg.rst
+++ b/docs/source/app_msg.rst
@@ -9,7 +9,10 @@ The MSG Interface (legacy interface)
    the process of releasing SimGrid 4. So MSG is frozen and will
    probably never evolve. If you are starting a new project, you
    should consider S4U instead. Note that the support for MSG will not
-   be removed from SimGrid before 2020 at least.
+   be removed from SimGrid before 2020Q4 or 2021Q1.
+
+   This interface is disabled by default. Pass -Denable_msg=ON to
+   cmake if you still need it.
 
 MSG is a simple API to write algorithms organized with Concurrent
 Sequential Processes (CSP) that interact by exchanging messages. It
@@ -44,7 +47,6 @@ The basic workflow is the following:
 .. doxygendefine:: MSG_init
 .. doxygenfunction:: MSG_launch_application
 .. doxygenfunction:: MSG_main
-.. doxygenfunction:: MSG_set_function
 
 Process Management
 ==================
@@ -88,7 +90,6 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions
 .. doxygenfunction:: MSG_process_sleep
 .. doxygenfunction:: MSG_process_suspend
 .. doxygenfunction:: MSG_process_unref
-.. doxygenfunction:: MSG_process_userdata_init
 .. doxygenfunction:: MSG_process_yield
 
 Host Management
@@ -98,10 +99,8 @@ Host Management
 .. doxygenfunction:: MSG_host_by_name
 .. doxygenfunction:: MSG_get_host_by_name
 .. doxygenfunction:: MSG_get_host_number
-.. doxygenfunction:: MSG_host_get_attached_storage_lists
 .. doxygenfunction:: MSG_host_get_core_number
 .. doxygenfunction:: MSG_host_get_data
-.. doxygenfunction:: MSG_host_get_mounted_storage_list
 .. doxygenfunction:: MSG_host_get_name
 .. doxygenfunction:: MSG_host_get_nb_pstates
 .. doxygenfunction:: MSG_host_get_load
@@ -111,7 +110,6 @@ Host Management
 .. doxygenfunction:: MSG_host_get_property_value
 .. doxygenfunction:: MSG_host_get_pstate
 .. doxygenfunction:: MSG_host_get_speed
-.. doxygenfunction:: MSG_host_is_off
 .. doxygenfunction:: MSG_host_is_on
 .. doxygenfunction:: MSG_host_off
 .. doxygenfunction:: MSG_host_on
@@ -127,6 +125,7 @@ Task Management
 Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 
 .. doxygentypedef:: msg_task_t
+.. doxygentypedef:: const_msg_task_t
 .. doxygendefine:: MSG_TASK_UNINITIALIZED
 
 .. doxygenfunction:: MSG_parallel_task_create
@@ -155,8 +154,6 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_listen_from
 .. doxygenfunction:: MSG_task_receive
 .. doxygenfunction:: MSG_task_receive_bounded
-.. doxygenfunction:: MSG_task_receive_ext
-.. doxygenfunction:: MSG_task_receive_ext_bounded
 .. doxygenfunction:: MSG_task_receive_with_timeout
 .. doxygenfunction:: MSG_task_receive_with_timeout_bounded
 .. doxygendefine:: MSG_task_recv
@@ -168,7 +165,6 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_set_bound
 .. doxygenfunction:: MSG_task_set_bytes_amount
 .. doxygenfunction:: MSG_task_set_category
-.. doxygenfunction:: MSG_task_set_copy_callback
 .. doxygenfunction:: MSG_task_set_data
 .. doxygenfunction:: MSG_task_set_flops_amount
 .. doxygenfunction:: MSG_task_set_name
@@ -184,7 +180,7 @@ Communications
 ==============
 
 .. doxygentypedef:: msg_comm_t
-
+.. doxygentypedef:: const_msg_comm_t
 .. doxygenfunction:: MSG_comm_destroy
 .. doxygenfunction:: MSG_comm_get_status
 .. doxygenfunction:: MSG_comm_get_task
@@ -246,26 +242,9 @@ processes.
 .. doxygenfunction:: MSG_vm_start
 .. doxygenfunction:: MSG_vm_suspend
 
-Storage Management
-==================
-Storage structure of MSG (:cpp:type:`msg_storage_t`) and associated functions, inspired from POSIX.
-
-.. doxygentypedef:: msg_storage_t
-.. doxygenfunction:: MSG_storage_get_by_name
-.. doxygenfunction:: MSG_storage_get_data
-.. doxygenfunction:: MSG_storage_get_host
-.. doxygenfunction:: MSG_storage_get_name
-.. doxygenfunction:: MSG_storage_get_properties
-.. doxygenfunction:: MSG_storage_get_property_value
-.. doxygenfunction:: MSG_storage_read
-.. doxygenfunction:: MSG_storages_as_dynar
-.. doxygenfunction:: MSG_storage_set_data
-.. doxygenfunction:: MSG_storage_set_property_value
-.. doxygenfunction:: MSG_storage_write
-
 NetZone Management
 ==================
-Network Zone (:cpp:class:`msg_file_t`) and associated functions.
+Network Zone (:cpp:type:`msg_netzone_t`) and associated functions.
 
 .. doxygentypedef:: msg_netzone_t
 .. doxygenfunction:: MSG_zone_get_by_name
@@ -276,10 +255,12 @@ Network Zone (:cpp:class:`msg_file_t`) and associated functions.
 .. doxygenfunction:: MSG_zone_get_sons
 .. doxygenfunction:: MSG_zone_set_property_value
 
+.. _Java_doc:
+
 Java bindings
 *************
 
-This section describes jMSG, the Java API to Simgrid. This API mimicks 
+This section describes jMSG, the Java API to Simgrid. This API mimics 
 :ref:`MSG <MSG_doc>`, which is a simple yet somehow realistic interface.
 The full reference documentation is provided at the end of this page.
 
@@ -301,14 +282,14 @@ Using the Java bindings
 In most cases, you can use the SimGrid bindings as if it was a Java
 library:
 
-.. code-block:: shell
+.. code-block:: console
 
    $ javac -classpath .:path/to/simgrid.jar your/java/Code.java
    $ java -classpath .:path/to/simgrid.jar your.java.Code the/parameter/to/your/code
 
 For example:
 
-.. code-block:: shell
+.. code-block:: console
 
    $ cd examples/deprecated/java
    $ java -classpath ../../simgrid.jar:. .:../../simgrid.jar app.pingpong.Main ../platforms/platform.xml 
@@ -381,7 +362,6 @@ Package org.simgrid.msg
 
    Class org.simgrid.msg.As <java/org/simgrid/msg/As>
    Class org.simgrid.msg.Comm <java/org/simgrid/msg/Comm>
-   Class org.simgrid.msg.File <java/org/simgrid/msg/File>
    Class org.simgrid.msg.Host <java/org/simgrid/msg/Host>
    Class org.simgrid.msg.HostFailureException <java/org/simgrid/msg/HostFailureException>
    Class org.simgrid.msg.HostNotFoundException <java/org/simgrid/msg/HostNotFoundException>
@@ -392,10 +372,7 @@ Package org.simgrid.msg
    Class org.simgrid.msg.Process <java/org/simgrid/msg/Process>
    Class org.simgrid.msg.ProcessKilledError <java/org/simgrid/msg/ProcessKilledError>
    Class org.simgrid.msg.ProcessNotFoundException <java/org/simgrid/msg/ProcessNotFoundException>
-   Class org.simgrid.msg.RngStream <java/org/simgrid/msg/RngStream>
    Class org.simgrid.msg.Semaphore <java/org/simgrid/msg/Semaphore>
-   Class org.simgrid.msg.Storage <java/org/simgrid/msg/Storage>
-   Class org.simgrid.msg.StorageNotFoundException <java/org/simgrid/msg/StorageNotFoundException>
    Class org.simgrid.msg.Task <java/org/simgrid/msg/Task>
    Class org.simgrid.msg.TaskCancelledException <java/org/simgrid/msg/TaskCancelledException>
    Class org.simgrid.msg.TimeoutException <java/org/simgrid/msg/TimeoutException>