Browse Source

doc/doxygen: improve doc

Nathalie Furmento 12 years ago
parent
commit
edee96a5fe

+ 2 - 2
doc/doxygen/chapters/advanced_examples.doxy

@@ -1124,8 +1124,8 @@ directory <c>examples/interface/</c>.
 
 \section SettingTheDataHandlesForATask Setting The Data Handles For A Task
 
-The number of data a task can manage is fixed by the
-<c>STARPU_NMAXBUFS</c> which has a default value which can be changed
+The number of data a task can manage is fixed by the environment variable
+\ref STARPU_NMAXBUFS which has a default value which can be changed
 through the configure option \ref enable-maxbuffers.
 
 However, it is possible to define tasks managing more data by using

+ 3 - 0
doc/doxygen/chapters/api/mpi.doxy

@@ -47,6 +47,7 @@ the world size. Communications statistics must be enabled (see
 \ref STARPU_COMM_STATS).
 
 @name Communication
+\anchor MPIPtpCommunication
 \ingroup API_MPI_Support
 
 \fn int starpu_mpi_send (starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm)
@@ -158,6 +159,7 @@ function does nothing if the cache mechanism is disabled (see
 \ref STARPU_MPI_CACHE).
 
 @name MPI Insert Task
+\anchor MPIInsertTask
 \ingroup API_MPI_Support
 
 \fn int starpu_data_set_tag (starpu_data_handle_t handle, int tag)
@@ -242,6 +244,7 @@ the function. On reception, the \p callback function is called with
 the argument \p arg.
 
 @name Collective Operations
+\anchor MPICollectiveOperations
 \ingroup API_MPI_Support
 
 \fn void starpu_mpi_redux_data (MPI_Comm comm, starpu_data_handle_t data_handle)

+ 5 - 5
doc/doxygen/chapters/mpi_support.doxy

@@ -165,8 +165,8 @@ will arrive just after, so as when the corresponding receive request
 will be submitted by the application, it'll copy this temporary handle
 into its one instead of submitting a new StarPU-MPI request.
 
-\ref API_MPI_Support gives the list of all the point to point
-communications defined in StarPU-MPI.
+\ref MPIPtpCommunication "Communication" gives the list of all the
+point to point communications defined in StarPU-MPI.
 
 \section ExchangingUserDefinedDataInterface Exchanging User Defined Data Interface
 
@@ -230,7 +230,7 @@ exchange the content of the handle. All MPI nodes then process the whole task
 graph, and StarPU automatically determines which node actually execute which
 task, and trigger the required MPI transfers.
 
-The list of functions is described in \ref API_MPI_Support.
+The list of functions is described in \ref MPIInsertTask "MPI Insert Task".
 
 Here an stencil example showing how to use starpu_mpi_insert_task(). One
 first needs to define a distribution function which specifies the
@@ -318,9 +318,9 @@ application can prune the task for loops according to the data distribution,
 so as to only submit tasks on nodes which have to care about them (either to
 execute them, or to send the required data).
 
-\section MPICollectiveOperations MPI Collective Operations
+\section MPICollective MPI Collective Operations
 
-The functions are described in \ref API_MPI_Support.
+The functions are described in \ref MPICollectiveOperations "MPI Collective Operations".
 
 \code{.c}
 if (rank == root)

+ 1 - 1
doc/doxygen/chapters/performance_feedback.doxy

@@ -34,7 +34,7 @@ call starpu_profiling_status_set() with the parameter
 ::STARPU_PROFILING_ENABLE. It is possible to detect whether monitoring
 is already enabled or not by calling starpu_profiling_status_get().
 Enabling monitoring also reinitialize all previously collected
-feedback. The <c>STARPU_PROFILING</c> environment variable can also be
+feedback. The environment variable \ref STARPU_PROFILING can also be
 set to 1 to achieve the same effect.
 
 Likewise, performance monitoring is stopped by calling