docs: Port all docstring to gtk-doc markdown

7 files changed, 26 insertions, 27 deletions

diff --git a/gst/goom/filters.c b/gst/goom/filters.c
index 703d20263..d0521fef0 100644
--- a/gst/goom/filters.c
+++ b/gst/goom/filters.c
@@ -150,14 +150,14 @@ typedef struct _ZOOM_FILTER_FX_WRAPPER_DATA
   int mustInitBuffers;
   int interlace_start;
 
-    /** modif by jeko : fixedpoint : buffration = (16:16) (donc 0<=buffration<=2^16) */
+    /* modif by jeko : fixedpoint : buffration = (16:16) (donc 0<=buffration<=2^16) */
   int buffratio;
   int *firedec;
 
-    /** modif d'optim by Jeko : precalcul des 4 coefs resultant des 2 pos */
+    /* modif d'optim by Jeko : precalcul des 4 coefs resultant des 2 pos */
   int precalCoef[BUFFPOINTNB][BUFFPOINTNB];
 
-    /** calculatePXandPY statics */
+    /* calculatePXandPY statics */
   int wave;
   int wavesp;
 
@@ -509,7 +509,7 @@ c_zoom (Pixel * expix1, Pixel * expix2, unsigned int prevX, unsigned int prevY,
   }
 }
 
-/** generate the water fx horizontal direction buffer */
+/* generate the water fx horizontal direction buffer */
 static void
 generateTheWaterFXHorizontalDirectionBuffer (PluginInfo * goomInfo,
     ZoomFilterFXWrapperData * data)
@@ -558,13 +558,12 @@ generateTheWaterFXHorizontalDirectionBuffer (PluginInfo * goomInfo,
 
 
 
-/**
-* Main work for the dynamic displacement map.
+/*
+ * Main work for the dynamic displacement map.
  * 
  * Reads data from pix1, write to pix2.
  *
  * Useful datas for this FX are stored in ZoomFilterData.
- * 
  * If you think that this is a strange function name, let me say that a long time ago,
  *  there has been a slow version and a gray-level only one. Then came these function,
  *  fast and workin in RGB colorspace ! nice but it only was applying a zoom to the image.
@@ -583,7 +582,7 @@ zoomFilterFastRGB (PluginInfo * goomInfo, Pixel * pix1, Pixel * pix2,
   if (!BVAL (data->enabled_bp))
     return;
 
-    /** changement de taille **/
+    /* changement de taille */
   if ((data->prevX != resx) || (data->prevY != resy)) {
     data->prevX = resx;
     data->prevY = resy;
@@ -609,7 +608,7 @@ zoomFilterFastRGB (PluginInfo * goomInfo, Pixel * pix1, Pixel * pix2,
   if (data->interlace_start != -2)
     zf = NULL;
 
-    /** changement de config **/
+    /* changement de config */
   if (zf) {
     data->reverse = zf->reverse;
     data->general_speed = (float) (zf->vitesse - 128) / 128.0f;
@@ -786,7 +785,7 @@ zoomFilterVisualFXWrapper_init (struct _VISUAL_FX *_this, PluginInfo * info)
   data->hPlaneEffect = 0;
   data->noisify = 2;
 
-    /** modif by jeko : fixedpoint : buffration = (16:16) (donc 0<=buffration<=2^16) */
+    /* modif by jeko : fixedpoint : buffration = (16:16) (donc 0<=buffration<=2^16) */
   data->buffratio = 0;
   data->firedec = 0;
 
@@ -800,7 +799,7 @@ zoomFilterVisualFXWrapper_init (struct _VISUAL_FX *_this, PluginInfo * info)
   _this->params = &data->params;
   _this->fx_data = (void *) data;
 
-    /** modif d'optim by Jeko : precalcul des 4 coefs resultant des 2 pos */
+    /* modif d'optim by Jeko : precalcul des 4 coefs resultant des 2 pos */
   generatePrecalCoef (data->precalCoef);
 }
 
diff --git a/gst/goom/goom_config.h b/gst/goom/goom_config.h
index 7264bfe4e..39b95a0f7 100644
--- a/gst/goom/goom_config.h
+++ b/gst/goom/goom_config.h
@@ -26,7 +26,7 @@
 
 #if 1
 /* ndef COLOR_BGRA */
-/** position des composantes **/
+/* position des composantes */
     #define BLEU 0
     #define VERT 1
     #define ROUGE 2
diff --git a/gst/goom/goom_filters.h b/gst/goom/goom_filters.h
index 13096e270..e4cfaeb0c 100644
--- a/gst/goom/goom_filters.h
+++ b/gst/goom/goom_filters.h
@@ -35,10 +35,10 @@ struct _ZOOM_FILTER_DATA
 	int     middleX, middleY;  /* milieu de l'effet */
 	char    reverse;           /* inverse la vitesse */
 	char    mode;              /* type d'effet � appliquer (cf les #define) */
-	/** @since June 2001 */
+	/* @since June 2001 */
 	int     hPlaneEffect;      /* deviation horitontale */
 	int     vPlaneEffect;      /* deviation verticale */
-	/** @since April 2002 */
+	/* @since April 2002 */
 	int     waveEffect;        /* applique une "surcouche" de wave effect */
 	int     hypercosEffect;    /* applique une "surcouche de hypercos effect */
 
diff --git a/gst/goom/goom_plugin_info.h b/gst/goom/goom_plugin_info.h
index da0e96e58..907d780c2 100644
--- a/gst/goom/goom_plugin_info.h
+++ b/gst/goom/goom_plugin_info.h
@@ -43,7 +43,7 @@ typedef struct {
 
 #define STATES_MAX_NB 128
 
-/**
+/*
  * Gives informations about the sound.
  */
 struct _SOUND_INFO {
@@ -86,7 +86,7 @@ struct _SOUND_INFO {
 };
 
 
-/**
+/*
  * Allows FXs to know the current state of the plugin.
  */
 struct _PLUGIN_INFO {
@@ -109,21 +109,21 @@ struct _PLUGIN_INFO {
 	int nbVisuals;
 	VisualFX **visuals; /* pointers on all the visual fx */
 
-	/** The known FX */
+	/* The known FX */
 	VisualFX convolve_fx;
 	VisualFX star_fx;
 	VisualFX zoomFilter_fx;
 	VisualFX tentacles_fx;
 	VisualFX ifs_fx;
 
-	/** image buffers */
+	/* image buffers */
 	guint32 *pixel;
 	guint32 *back;
 	Pixel *p1, *p2;
 	Pixel *conv;
   Pixel *outputBuf;
 
-	/** state of goom */
+	/* state of goom */
 	guint32 cycle;
 	GoomState states[STATES_MAX_NB];
 	int statesNumber;
@@ -131,16 +131,16 @@ struct _PLUGIN_INFO {
 
 	GoomState *curGState;
 
-	/** effet de ligne.. */
+	/* effet de ligne.. */
 	GMLine *gmline1;
 	GMLine *gmline2;
 
-	/** sinus table */
+	/* sinus table */
 	int sintable[0x10000];
 
 	/* INTERNALS */
 	
-	/** goom_update internals.
+	/* goom_update internals.
 	 * I took all static variables from goom_update and put them here.. for the moment.
 	 */
 	struct {
diff --git a/gst/goom/gstgoom.c b/gst/goom/gstgoom.c
index dbbe94184..494234550 100644
--- a/gst/goom/gstgoom.c
+++ b/gst/goom/gstgoom.c
@@ -22,17 +22,17 @@
 
 /**
  * SECTION:element-goom
+ * @title: goom
  * @see_also: synaesthesia
  *
  * Goom is an audio visualisation element. It creates warping structures
  * based on the incoming audio signal.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 -v audiotestsrc ! goom ! videoconvert ! xvimagesink
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/gst/goom/ifs.c b/gst/goom/ifs.c
index 5438e31b4..5af721fb6 100644
--- a/gst/goom/ifs.c
+++ b/gst/goom/ifs.c
@@ -725,7 +725,7 @@ ifs_update (PluginInfo * goomInfo, Pixel * data, Pixel * back, int increment,
       | (col[ROUGE] << (ROUGE * 8));
 }
 
-/** VISUAL_FX WRAPPER FOR IFS */
+/* VISUAL_FX WRAPPER FOR IFS */
 
 static void
 ifs_vfx_apply (VisualFX * _this, Pixel * src, Pixel * dest,
diff --git a/gst/goom/sound_tester.h b/gst/goom/sound_tester.h
index 2651d5f9d..26418c5e2 100644
--- a/gst/goom/sound_tester.h
+++ b/gst/goom/sound_tester.h
@@ -22,7 +22,7 @@
 #include "goom_plugin_info.h"
 #include "goom_config.h"
 
-/** change les donnees du SoundInfo */
+/* change les donnees du SoundInfo */
 void evaluate_sound(gint16 data[2][512], SoundInfo *sndInfo);
 
 #endif