소스 검색

doc: add missing parts

Nathalie Furmento 11 년 전
부모
커밋
b1d374b783
5개의 변경된 파일42개의 추가작업 그리고 27개의 파일을 삭제
  1. 2 0
      doc/doxygen/Makefile.am
  2. 31 24
      doc/doxygen/chapters/45files.doxy
  3. 1 1
      doc/doxygen/chapters/api/threads.doxy
  4. 4 2
      doc/doxygen/doxygen-config.cfg.in
  5. 4 0
      doc/doxygen/refman.tex

+ 2 - 0
doc/doxygen/Makefile.am

@@ -100,6 +100,8 @@ chapters =	\
 	chapters/api/versioning.doxy \
 	chapters/api/versioning.doxy \
 	chapters/api/workers.doxy \
 	chapters/api/workers.doxy \
 	chapters/api/threads.doxy \
 	chapters/api/threads.doxy \
+	chapters/api/bitmap.doxy \
+	chapters/api/tree.doxy \
 	chapters/api/toolbox.doxy \
 	chapters/api/toolbox.doxy \
 	chapters/api/sc_hypervisor/sc_hypervisor.doxy \
 	chapters/api/sc_hypervisor/sc_hypervisor.doxy \
 	chapters/api/sc_hypervisor/sc_hypervisor_usage.doxy
 	chapters/api/sc_hypervisor/sc_hypervisor_usage.doxy

+ 31 - 24
doc/doxygen/chapters/45files.doxy

@@ -1,52 +1,59 @@
 /*
 /*
  * 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.
 */
 */
 
 
 /*! \page Files Files
 /*! \page Files Files
 
 
-\file starpu_deprecated_api.h
+\file starpu_config.h
+
 \file starpu.h
 \file starpu.h
+\file starpu_bitmap.h
+\file starpu_bound.h
+\file starpu_cublas.h
+\file starpu_cuda.h
 \file starpu_data_filters.h
 \file starpu_data_filters.h
+\file starpu_data.h
 \file starpu_data_interfaces.h
 \file starpu_data_interfaces.h
+\file starpu_deprecated_api.h
 \file starpu_disk.h
 \file starpu_disk.h
-\file starpu_worker.h
-\file starpu_task.h
-\file starpu_task_bundle.h
-\file starpu_task_list.h
-\file starpu_task_util.h
-\file starpu_data.h
-\file starpu_perfmodel.h
-\file starpu_util.h
+\file starpu_driver.h
+\file starpu_expert.h
 \file starpu_fxt.h
 \file starpu_fxt.h
-\file starpu_cuda.h
-\file starpu_opencl.h
-\file starpu_sink.h
+\file starpu_hash.h
 \file starpu_mic.h
 \file starpu_mic.h
-\file starpu_scc.h
-\file starpu_expert.h
+\file starpu_opencl.h
+\file starpu_perfmodel.h
 \file starpu_profiling.h
 \file starpu_profiling.h
-\file starpu_bound.h
-\file starpu_scheduler.h
+\file starpu_rand.h
+\file starpu_scc.h
 \file starpu_sched_ctx.h
 \file starpu_sched_ctx.h
 \file starpu_sched_ctx_hypervisor.h
 \file starpu_sched_ctx_hypervisor.h
-\file starpu_top.h
-\file starpu_hash.h
-\file starpu_rand.h
-\file starpu_cublas.h
-\file starpu_driver.h
+\file starpu_scheduler.h
+\file starpu_sink.h
 \file starpu_stdlib.h
 \file starpu_stdlib.h
+\file starpu_task_bundle.h
+\file starpu_task.h
+\file starpu_task_list.h
+\file starpu_task_util.h
 \file starpu_thread.h
 \file starpu_thread.h
 \file starpu_thread_util.h
 \file starpu_thread_util.h
+\file starpu_top.h
+\file starpu_tree.h
+\file starpu_util.h
+\file starpu_worker.h
+
 \file starpu_mpi.h
 \file starpu_mpi.h
-\file sc_hypervisor.h
+
 \file sc_hypervisor_config.h
 \file sc_hypervisor_config.h
+\file sc_hypervisor.h
 \file sc_hypervisor_lp.h
 \file sc_hypervisor_lp.h
 \file sc_hypervisor_monitoring.h
 \file sc_hypervisor_monitoring.h
 \file sc_hypervisor_policy.h
 \file sc_hypervisor_policy.h
-\file starpu_config.h
+
+\file starpufft.h
 
 
 */
 */

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

@@ -11,7 +11,7 @@
 \brief This section describes the thread facilities provided
 \brief This section describes the thread facilities provided
 by StarPU. The thread function are either implemented on top of the
 by StarPU. The thread function are either implemented on top of the
 pthread library or the Simgrid library when the simulated performance
 pthread library or the Simgrid library when the simulated performance
-mode is enabled (\ref SimulatedPerformance).
+mode is enabled (\ref SimGridSupport).
 
 
 \def STARPU_PTHREAD_CREATE_ON
 \def STARPU_PTHREAD_CREATE_ON
 \ingroup API_Threads
 \ingroup API_Threads

+ 4 - 2
doc/doxygen/doxygen-config.cfg.in

@@ -1,7 +1,7 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
 #
 # Copyright (C) 2009-2013  Université de Bordeaux 1
 # Copyright (C) 2009-2013  Université 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  Télécom-SudParis
 # Copyright (C) 2011  Télécom-SudParis
 # Copyright (C) 2011, 2012  Institut National de Recherche en Informatique et Automatique
 # Copyright (C) 2011, 2012  Institut National de Recherche en Informatique et Automatique
 #
 #
@@ -20,14 +20,15 @@ INPUT                  = @top_srcdir@/doc/doxygen/chapters \
 		       	 @top_srcdir@/doc/doxygen/chapters/api \
 		       	 @top_srcdir@/doc/doxygen/chapters/api \
 		       	 @top_srcdir@/doc/doxygen/chapters/api/sc_hypervisor \
 		       	 @top_srcdir@/doc/doxygen/chapters/api/sc_hypervisor \
                          @top_builddir@/doc/doxygen/starpu_config.h \
                          @top_builddir@/doc/doxygen/starpu_config.h \
+			 @top_srcdir@/include/starpu_bitmap.h \
 	 		 @top_srcdir@/include/starpu_bound.h \
 	 		 @top_srcdir@/include/starpu_bound.h \
 			 @top_srcdir@/include/starpu_cublas.h \
 			 @top_srcdir@/include/starpu_cublas.h \
 			 @top_srcdir@/include/starpu_cuda.h \
 			 @top_srcdir@/include/starpu_cuda.h \
 			 @top_srcdir@/include/starpu_data_filters.h \
 			 @top_srcdir@/include/starpu_data_filters.h \
 			 @top_srcdir@/include/starpu_data.h \
 			 @top_srcdir@/include/starpu_data.h \
 			 @top_srcdir@/include/starpu_data_interfaces.h \
 			 @top_srcdir@/include/starpu_data_interfaces.h \
-			 @top_srcdir@/include/starpu_disk.h \
 			 @top_srcdir@/include/starpu_deprecated_api.h \
 			 @top_srcdir@/include/starpu_deprecated_api.h \
+			 @top_srcdir@/include/starpu_disk.h \
 			 @top_srcdir@/include/starpu_driver.h \
 			 @top_srcdir@/include/starpu_driver.h \
 			 @top_srcdir@/include/starpu_expert.h \
 			 @top_srcdir@/include/starpu_expert.h \
 			 @top_srcdir@/include/starpu_fxt.h \
 			 @top_srcdir@/include/starpu_fxt.h \
@@ -51,6 +52,7 @@ INPUT                  = @top_srcdir@/doc/doxygen/chapters \
 			 @top_srcdir@/include/starpu_thread.h \
 			 @top_srcdir@/include/starpu_thread.h \
 			 @top_srcdir@/include/starpu_thread_util.h \
 			 @top_srcdir@/include/starpu_thread_util.h \
 			 @top_srcdir@/include/starpu_top.h \
 			 @top_srcdir@/include/starpu_top.h \
+			 @top_srcdir@/include/starpu_tree.h \
 			 @top_srcdir@/include/starpu_util.h \
 			 @top_srcdir@/include/starpu_util.h \
 			 @top_srcdir@/include/starpu_worker.h \
 			 @top_srcdir@/include/starpu_worker.h \
 			 @top_srcdir@/mpi/include/ \
 			 @top_srcdir@/mpi/include/ \

+ 4 - 0
doc/doxygen/refman.tex

@@ -226,6 +226,7 @@ Documentation License”.
 \input{group__API__Standard__Memory__Library}
 \input{group__API__Standard__Memory__Library}
 \input{group__API__Toolbox}
 \input{group__API__Toolbox}
 \input{group__API__Threads}
 \input{group__API__Threads}
+\input{group__API__Bitmap}
 \input{group__API__Workers__Properties}
 \input{group__API__Workers__Properties}
 \input{group__API__Data__Management}
 \input{group__API__Data__Management}
 \input{group__API__Data__Interfaces}
 \input{group__API__Data__Interfaces}
@@ -255,6 +256,7 @@ Documentation License”.
 \input{group__API__StarPUTop__Interface}
 \input{group__API__StarPUTop__Interface}
 \input{group__API__Scheduling__Contexts}
 \input{group__API__Scheduling__Contexts}
 \input{group__API__Scheduling__Policy}
 \input{group__API__Scheduling__Policy}
+\input{group__API__Tree}
 \input{group__API__SC__Hypervisor__usage}
 \input{group__API__SC__Hypervisor__usage}
 \input{group__API__SC__Hypervisor}
 \input{group__API__SC__Hypervisor}
 
 
@@ -266,6 +268,7 @@ Documentation License”.
 \hypertarget{FileDocumentation}{}
 \hypertarget{FileDocumentation}{}
 
 
 \input{starpu_8h}
 \input{starpu_8h}
+\input{starpu__bitmap_8h}
 \input{starpu__bound_8h}
 \input{starpu__bound_8h}
 \input{starpu__config_8h}
 \input{starpu__config_8h}
 \input{starpu__cublas_8h}
 \input{starpu__cublas_8h}
@@ -297,6 +300,7 @@ Documentation License”.
 \input{starpu__thread_8h}
 \input{starpu__thread_8h}
 \input{starpu__thread__util_8h}
 \input{starpu__thread__util_8h}
 \input{starpu__top_8h}
 \input{starpu__top_8h}
+\input{starpu__tree_8h}
 \input{starpu__util_8h}
 \input{starpu__util_8h}
 \input{starpu__worker_8h}
 \input{starpu__worker_8h}
 \input{starpu__mpi_8h}
 \input{starpu__mpi_8h}