doc: no longer use doxygen internal command, rather use // to identify comments and filter them out before getting the file processed by doxygen

doc/doxygen/chapters/00introduction.doxy

@@ -16,9 +16,8 @@
 
 \section Motivation Motivation
 
-\internal
-complex machines with heterogeneous cores/devices
-\endinternal
+// This is a comment and it will be removed before the file is processed by doxygen
+// complex machines with heterogeneous cores/devices
 
 The use of specialized hardware such as accelerators or coprocessors offers an
 interesting approach to overcome the physical limits encountered by processor
@@ -35,14 +34,11 @@ efficiently mapping and executing tasks onto an heterogeneous machine while
 transparently handling low-level issues such as data transfers in a portable
 fashion.
 
-\internal
-this leads to a complicated distributed memory design
-which is not (easily) manageable by hand
-
-added value/benefits of StarPU
-   - portability
-   - scheduling, perf. portability
-\endinternal
+// this leads to a complicated distributed memory design
+// which is not (easily) manageable by hand
+// added value/benefits of StarPU
+//    - portability
+//   - scheduling, perf. portability
 
 \section StarPUInANutshell StarPU in a Nutshell
 
@@ -73,9 +69,7 @@ policies in a portable fashion (\ref DefiningANewSchedulingPolicy).
 
 The remainder of this section describes the main concepts used in StarPU.
 
-\internal
-explain the notion of codelet and task (i.e. g(A, B)
-\endinternal
+// explain the notion of codelet and task (i.e. g(A, B)
 
 \subsection CodeletAndTasks Codelet and Tasks
 
@@ -83,9 +77,7 @@ One of the StarPU primary data structures is the \b codelet. A codelet describes
 computational kernel that can possibly be implemented on multiple architectures
 such as a CPU, a CUDA device or an OpenCL device.
 
-\internal
-TODO insert illustration f: f_spu, f_cpu, ...
-\endinternal
+// TODO insert illustration f: f_spu, f_cpu, ...
 
 Another important data structure is the \b task. Executing a StarPU task
 consists in applying a codelet on a data set, on one of the architectures on
@@ -108,13 +100,8 @@ submitting other tasks, or by expressing dependencies
 between tags (which can thus correspond to tasks that have not been submitted
 yet).
 
-\internal
-TODO insert illustration f(Ar, Brw, Cr) + ..
-\endinternal
-
-\internal
-DSM
-\endinternal
+// TODO insert illustration f(Ar, Brw, Cr) + ..
+// DSM
 
 \subsection StarPUDataManagementLibrary StarPU Data Management Library
 
@@ -130,15 +117,12 @@ several processing units as long as it is not modified.
 
 TODO
 
-\internal
-TODO: section describing what taskifying an application means: before
-porting to StarPU, turn the program into:
-"pure" functions, which only access data from their passed parameters
-a main function which just calls these pure functions
-
-and then it's trivial to use StarPU or any other kind of task-based library:
-simply replace calling the function with submitting a task.
-\endinternal
+// TODO: section describing what taskifying an application means: before
+// porting to StarPU, turn the program into:
+// "pure" functions, which only access data from their passed parameters
+// a main function which just calls these pure functions
+// and then it's trivial to use StarPU or any other kind of task-based library:
+// simply replace calling the function with submitting a task.
 
 \section Glossary Glossary
 

doc/doxygen/chapters/02basic_examples.doxy

@@ -109,9 +109,7 @@ starpu_task_create(). This function only allocates and fills the
 corresponding structure with the default settings, but it does not
 submit the task to StarPU.
 
-\internal
-not really clear ;)
-\endinternal
+// not really clear ;)
 
 The field starpu_task::cl is a pointer to the codelet which the task will
 execute: in other words, the codelet structure describes which computational
@@ -198,9 +196,7 @@ not count the argument --- the parameter <c>cl_arg</c> of the function
 <c>cpu_func</c> --- since it is not managed by our data management
 library, but just contains trivial parameters.
 
-\internal
-TODO rewrite so that it is a little clearer ?
-\endinternal
+// TODO rewrite so that it is a little clearer ?
 
 Be aware that this may be a pointer to a
 \em copy of the actual buffer, and not the pointer given by the programmer:

doc/doxygen/chapters/05performance_feedback.doxy

@@ -108,10 +108,8 @@ these values during the time, for the different workers.
 
 TODO: ajouter \ref STARPU_BUS_STATS
 
-\internal
-how to enable/disable performance monitoring
-what kind of information do we get ?
-\endinternal
+// how to enable/disable performance monitoring
+// what kind of information do we get ?
 
 The bus speed measured by StarPU can be displayed by using the tool
 <c>starpu_machine_display</c>, for instance:
@@ -608,10 +606,7 @@ task, and each color corresponds to a codelet.
 \image html data_trace.png
 \image latex data_trace.eps "" width=\textwidth
 
-
-\internal
-TODO: data transfer stats are similar to the ones displayed when
-setting STARPU_BUS_STATS
-\endinternal
+// TODO: data transfer stats are similar to the ones displayed when
+// setting STARPU_BUS_STATS
 
 */

doc/doxygen/chapters/11c_extensions.doxy

@@ -107,9 +107,7 @@ as a type qualifier for output pointer or array parameters
 Declare the given function as an implementation of <c>task</c> to run on
 <c>target</c>.  <c>target</c> must be a string, currently one of
 <c>"cpu"</c>, <c>"opencl"</c>, or <c>"cuda"</c>.
-\internal
-FIXME: Update when OpenCL support is ready.
-\endinternal
+// FIXME: Update when OpenCL support is ready.
 </dd>
 </dl>
 

doc/doxygen/chapters/16configure_options.doxy

@@ -408,9 +408,7 @@ CUDA. Still experimental.
 \anchor enable-opengl-render
 \addindex __configure__--enable-opengl-render
 Enable the use of OpenGL for the rendering of some examples.
-\internal
-TODO: rather default to enabled when detected
-\endinternal
+// TODO: rather default to enabled when detected
 </dd>
 
 <dt>--enable-blas-lib</dt>

doc/doxygen/doxygen_filter.sh.in

@@ -3,7 +3,6 @@
 if [ "$(basename $1)" == "starpufft.h" ] ; then
     gcc -E $1 -I @top_srcdir@/include/ -I @top_builddir@/include/ |grep starpufft
 else
-    SUFFIX_C=$(basename $1 .c)
-    sed -e 's/STARPU_DEPRECATED//' $1
+    sed -e 's/STARPU_DEPRECATED//' $1 | sed 's/\/\/.*//'
 fi