Browse Source

doxygen: fix ref commands and small typos

Nathalie Furmento 11 years ago
parent
commit
95b0599a65

+ 2 - 2
doc/doxygen/chapters/10scheduling_context_hypervisor.doxy

@@ -1,7 +1,7 @@
 /*
 /*
  * This file is part of the StarPU Handbook.
  * This file is part of the StarPU Handbook.
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
  * Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
- * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+ * Copyright (C) 2010, 2011, 2012, 2013, 2014  Centre National de la Recherche Scientifique
  * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
  * See the file version.doxy for copying conditions.
  * See the file version.doxy for copying conditions.
  */
  */
@@ -192,7 +192,7 @@ The <b>Throughput </b> strategy focuses on maximizing the throughput of the reso
 and resizes the contexts such that the machine is running at its maximum efficiency
 and resizes the contexts such that the machine is running at its maximum efficiency
 (maximum instant speed of the workers).
 (maximum instant speed of the workers).
 
 
-\section  Defining a new hypervisor policy
+\section DefiningANewHypervisorPolicy Defining A New Hypervisor Policy
 
 
 While Scheduling Context Hypervisor Plugin comes with a variety of
 While Scheduling Context Hypervisor Plugin comes with a variety of
 resizing policies (see \ref ResizingStrategies), it may sometimes be
 resizing policies (see \ref ResizingStrategies), it may sometimes be

+ 1 - 1
doc/doxygen/chapters/21simgrid.doxy

@@ -22,7 +22,7 @@ get the simulated time, it has to use starpu_timing_now() which returns the
 virtual timestamp in us.
 virtual timestamp in us.
 
 
 For some technical reason, the application's .c file which contains main() has
 For some technical reason, the application's .c file which contains main() has
-to be recompiled with starpu.h, which in the simgrid case will #define main()
+to be recompiled with starpu.h, which in the simgrid case will # define main()
 into starpu_main(), and it is libstarpu which will provide the real main() and
 into starpu_main(), and it is libstarpu which will provide the real main() and
 call the application's main().
 call the application's main().
 
 

+ 3 - 3
doc/doxygen/chapters/api/threads.doxy

@@ -152,7 +152,7 @@ This function initializes the thread attributes object pointed to by
 \p attr with default attribute values.
 \p attr with default attribute values.
 
 
 It does not do anything when the simulated performance mode is enabled
 It does not do anything when the simulated performance mode is enabled
-(\ref SimulatedPerformance).
+(\ref SimGridSupport).
 
 
 \fn int starpu_pthread_attr_destroy(starpu_pthread_attr_t *attr)
 \fn int starpu_pthread_attr_destroy(starpu_pthread_attr_t *attr)
 \ingroup API_Threads
 \ingroup API_Threads
@@ -161,7 +161,7 @@ required. Destroying a thread attributes object has no effect on
 threads that were created using that object.
 threads that were created using that object.
 
 
 It does not do anything when the simulated performance mode is enabled
 It does not do anything when the simulated performance mode is enabled
-(\ref SimulatedPerformance).
+(\ref SimGridSupport).
 
 
 \fn int starpu_pthread_attr_setdetachstate(starpu_pthread_attr_t *attr, int detachstate)
 \fn int starpu_pthread_attr_setdetachstate(starpu_pthread_attr_t *attr, int detachstate)
 \ingroup API_Threads
 \ingroup API_Threads
@@ -172,7 +172,7 @@ created using the thread attributes object \p attr will be created in
 a joinable or a detached state.
 a joinable or a detached state.
 
 
 It does not do anything when the simulated performance mode is enabled
 It does not do anything when the simulated performance mode is enabled
-(\ref SimulatedPerformance).
+(\ref SimGridSupport).
 
 
 \fn int starpu_pthread_mutex_init(starpu_pthread_mutex_t *mutex, const starpu_pthread_mutexattr_t *mutexattr)
 \fn int starpu_pthread_mutex_init(starpu_pthread_mutex_t *mutex, const starpu_pthread_mutexattr_t *mutexattr)
 \ingroup API_Threads
 \ingroup API_Threads