doc: add comment to snippet command to indicate in final document if tne command was successfull or not

doc/doxygen/chapters/02basic_examples.doxy

@@ -22,7 +22,7 @@ implementations (for CPU, OpenCL, and/or CUDA), and invoke the task like
 a regular C function.  The example below defines <c>my_task</c> which
 has a single implementation for CPU:
 
-\snippet hello_pragma.c To be included
+\snippet hello_pragma.c To be included. You should update doxygen if you see that text.
 
 The code can then be compiled and linked with GCC and the flag <c>-fplugin</c>:
 
@@ -352,7 +352,7 @@ vector_scal (unsigned size, float vector[size], float factor)
 Next, the body of the program, which uses the task defined above, can be
 implemented:
 
-\snippet hello_pragma2.c To be included
+\snippet hello_pragma2.c To be included. You should update doxygen if you see that text.
 
 The function <c>main</c> above does several things:
 
@@ -488,7 +488,7 @@ The actual implementation of the CUDA task goes into a separate
 compilation unit, in a <c>.cu</c> file.  It is very close to the
 implementation when using StarPU's standard C API (\ref DefinitionOfTheCUDAKernel).
 
-\snippet scal_pragma.cu To be included
+\snippet scal_pragma.cu To be included. You should update doxygen if you see that text.
 
 The complete source code, in the directory <c>gcc-plugin/examples/vector_scal</c>
 of the StarPU distribution, also shows how an SSE-specialized
@@ -628,7 +628,7 @@ that the vector pointer returned by ::STARPU_VECTOR_GET_PTR is here a
 pointer in GPU memory, so that it can be passed as such to the
 kernel call <c>vector_mult_cuda</c>.
 
-\snippet vector_scal_cuda.cu To be included
+\snippet vector_scal_cuda.cu To be included. You should update doxygen if you see that text.
 
 \subsection DefinitionOfTheOpenCLKernel Definition of the OpenCL Kernel
 
@@ -650,7 +650,7 @@ which returns a <c>cl_mem</c> (which is not a device pointer, but an OpenCL
 handle), which can be passed as such to the OpenCL kernel. The difference is
 important when using partitioning, see \ref PartitioningData.
 
-\snippet vector_scal_opencl.c To be included
+\snippet vector_scal_opencl.c To be included. You should update doxygen if you see that text.
 
 \subsection DefinitionOfTheMainCode Definition of the Main Code
 
@@ -661,7 +661,7 @@ starpu_codelet::cuda_funcs and starpu_codelet::opencl_funcs are set to
 define the pointers to the CUDA and OpenCL implementations of the
 task.
 
-\snippet vector_scal_c.c To be included
+\snippet vector_scal_c.c To be included. You should update doxygen if you see that text.
 
 \subsection ExecutionOfHybridVectorScaling Execution of Hybrid Vector Scaling
 

doc/doxygen/chapters/03advanced_examples.doxy

@@ -769,7 +769,7 @@ the CPU binding mask that StarPU chose.
 For instance, using OpenMP (full source is available in
 <c>examples/openmp/vector_scal.c</c>):
 
-\snippet forkmode.c To be included
+\snippet forkmode.c To be included. You should update doxygen if you see that text.
 
 Other examples include for instance calling a BLAS parallel CPU implementation
 (see <c>examples/mult/xgemm.c</c>).
@@ -891,7 +891,7 @@ will be able to convert data from one data structure to the other when needed.
 Note that the scheduler <c>dmda</c> is the only one optimized for this
 interface. The user must provide StarPU with conversion codelets:
 
-\snippet multiformat.c To be included
+\snippet multiformat.c To be included. You should update doxygen if you see that text.
 
 Kernels can be written almost as for any other interface. Note that
 ::STARPU_MULTIFORMAT_GET_CPU_PTR shall only be used for CPU kernels. CUDA kernels
@@ -1115,7 +1115,7 @@ Similar functions need to be defined to access the different fields of the
 complex interface from a <c>void *</c> pointer to be used within codelet
 implemetations.
 
-\snippet complex.c To be included
+\snippet complex.c To be included. You should update doxygen if you see that text.
 
 Complex data interfaces can then be registered to StarPU.
 

doc/doxygen/chapters/04optimize_performance.doxy

@@ -547,6 +547,6 @@ case. Since during simgrid execution, the functions of the codelet are actually
 not called, one can use dummy functions such as the following to still permit
 CUDA or OpenCL execution:
 
-\snippet simgrid.c To be included
+\snippet simgrid.c To be included. You should update doxygen if you see that text.
 
 */

doc/doxygen/chapters/11c_extensions.doxy

@@ -322,7 +322,7 @@ automatic variables.
 The following example illustrates use of the <c>heap_allocated</c>
 attribute:
 
-\snippet cholesky_pragma.c To be included
+\snippet cholesky_pragma.c To be included. You should update doxygen if you see that text.
 
 \section UsingCExtensionsConditionally Using C Extensions Conditionally
 
@@ -340,7 +340,7 @@ extensions.
 The code below illustrates how to define a task and its implementations
 in a way that allows it to be compiled without the GCC plug-in:
 
-\snippet matmul_pragma.c To be included
+\snippet matmul_pragma.c To be included. You should update doxygen if you see that text.
 
 The above program is a valid StarPU program when StarPU's GCC plug-in is
 used; it is also a valid sequential program when the plug-in is not
@@ -354,7 +354,7 @@ unable to parse the attribute syntax (In practice, Clang and
 several proprietary compilers implement attributes.), so you may want to
 wrap attributes in macros like this:
 
-\snippet matmul_pragma2.c To be included
+\snippet matmul_pragma2.c To be included. You should update doxygen if you see that text.
 
 */
 

doc/doxygen/chapters/code/cholesky_pragma.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 extern void cholesky(unsigned nblocks, unsigned size,
                     float mat[nblocks][nblocks][size])
   __attribute__ ((task));
@@ -47,4 +47,4 @@ main (int argc, char *argv[])
 
   return EXIT_SUCCESS;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/complex.c

@@ -15,11 +15,11 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 #define STARPU_COMPLEX_GET_REAL(interface)	\
         (((struct starpu_complex_interface *)(interface))->real)
 #define STARPU_COMPLEX_GET_IMAGINARY(interface)	\
         (((struct starpu_complex_interface *)(interface))->imaginary)
 #define STARPU_COMPLEX_GET_NX(interface)	\
         (((struct starpu_complex_interface *)(interface))->nx)
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/disk_compute.c

@@ -13,7 +13,7 @@
  *
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 /* Try to write into disk memory
  * Use mechanism to push datas from main ram to disk ram
  */
@@ -175,5 +175,5 @@ enodev:
 enoent:
 	return 77;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 

doc/doxygen/chapters/code/disk_copy.c

@@ -14,7 +14,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 
 /* Try to write into disk memory
  * Use mechanism to push datas from main ram to disk ram
@@ -119,4 +119,4 @@ enoent:
 	return 77;
 }
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/forkmode.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 void scal_cpu_func(void *buffers[], void *_args)
 {
     unsigned i;
@@ -39,4 +39,4 @@ static struct starpu_codelet cl =
     .cpu_funcs_name = {"scal_cpu_func", NULL},
     .nbuffers = 1,
 };
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/hello_pragma.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 #include <stdio.h>
 
 /* Task declaration.  */
@@ -43,4 +43,4 @@ int main ()
 
   return 0;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/hello_pragma2.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 int main (void)
 {
 #pragma starpu initialize
@@ -40,4 +40,4 @@ int main (void)
 
   return valid ? EXIT_SUCCESS : EXIT_FAILURE;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/matmul_pragma.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 /* This program is valid, whether or not StarPU's GCC plug-in
    is being used.  */
 
@@ -70,4 +70,4 @@ main (int argc, char *argv[])
 
   return EXIT_SUCCESS;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/matmul_pragma2.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 /* Use the `task' attribute only when StarPU's GCC plug-in
    is available.   */
 #ifdef STARPU_GCC_PLUGIN
@@ -26,4 +26,4 @@
 
 static void matmul (const float *A, const float *B, float *C,
                     unsigned nx, unsigned ny, unsigned nz) __task;
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/multiformat.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 #define NX 1024
 struct point array_of_structs[NX];
 starpu_data_handle_t handle;
@@ -58,4 +58,4 @@ struct starpu_multiformat_data_interface_ops format_ops = {
 };
 
 starpu_multiformat_data_register(handle, STARPU_MAIN_RAM, &array_of_structs, NX, &format_ops);
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/scal_pragma.cu

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 /* CUDA implementation of the `vector_scal' task, to be compiled with `nvcc'. */
 
 #include <starpu.h>
@@ -42,4 +42,4 @@ vector_scal_cuda (size_t size, float vector[], float factor)
 
   cudaStreamSynchronize (starpu_cuda_get_local_stream ());
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/simgrid.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 static struct starpu_codelet cl11 =
 {
 	.cpu_funcs = {chol_cpu_codelet_update_u11, NULL},
@@ -29,4 +29,4 @@ static struct starpu_codelet cl11 =
 	.modes = {STARPU_RW},
 	.model = &chol_model_11
 };
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/vector_scal_c.c

@@ -15,7 +15,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 /*
  * This example demonstrates how to use StarPU to scale an array by a factor.
  * It shows how to manipulate data with StarPU's data management library.
@@ -125,4 +125,4 @@ int main(int argc, char **argv)
 
     return 0;
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/vector_scal_cpu.c

@@ -1,6 +1,6 @@
 /* StarPU --- Runtime system for heterogeneous multicore architectures.
  *
- * Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
+ * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
  *
  * StarPU is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -14,7 +14,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 
 #include <starpu.h>
 #include <xmmintrin.h>
@@ -75,4 +75,4 @@ void scal_sse_func(void *buffers[], void *cl_arg)
         }
     }
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/vector_scal_cuda.cu

@@ -14,7 +14,7 @@
  *
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 #include <starpu.h>
 
 static __global__ void vector_mult_cuda(unsigned n, float *val,
@@ -41,5 +41,4 @@ extern "C" void scal_cuda_func(void *buffers[], void *_args)
 
         cudaStreamSynchronize(starpu_cuda_get_local_stream());
 }
-//! [To be included]
-
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/vector_scal_opencl.c

@@ -16,7 +16,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 #include <starpu.h>
 
 extern struct starpu_opencl_program programs;
@@ -75,4 +75,4 @@ void scal_opencl_func(void *buffers[], void *_args)
 	 starpu_opencl_release_kernel(kernel);
     }
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]

doc/doxygen/chapters/code/vector_scal_opencl_codelet.cl

@@ -14,7 +14,7 @@
  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
  */
 
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]
 __kernel void vector_mult_opencl(int nx, __global float* val, float factor)
 {
         const int i = get_global_id(0);
@@ -22,4 +22,4 @@ __kernel void vector_mult_opencl(int nx, __global float* val, float factor)
                 val[i] *= factor;
         }
 }
-//! [To be included]
+//! [To be included. You should update doxygen if you see that text.]