Don't use gtk-doc markers for normal comments. Fix gtk-doc formatting where required.

Original commit message from CVS:
* ext/tarkin/wavelet.c:
* ext/tarkin/wavelet.h:
* gst/mpegaudioparse/gstmpegaudioparse.c:
* gst/vbidec/vbidata.c:
* gst/vbidec/vbiscreen.h:
* sys/dxr3/ac3_padder.c:
* sys/dxr3/dxr3audiosink.c:
* sys/dxr3/dxr3spusink.c:
* sys/dxr3/dxr3videosink.c:
* sys/qcam/dark.c:
Don't use gtk-doc markers for normal comments. Fix
gtk-doc formatting where required.

diff --git a/ChangeLog b/ChangeLog
index 702f712..72050d9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2005-11-09  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * ext/tarkin/wavelet.c:
+       * ext/tarkin/wavelet.h:
+       * gst/mpegaudioparse/gstmpegaudioparse.c:
+       * gst/vbidec/vbidata.c:
+       * gst/vbidec/vbiscreen.h:
+       * sys/dxr3/ac3_padder.c:
+       * sys/dxr3/dxr3audiosink.c:
+       * sys/dxr3/dxr3spusink.c:
+       * sys/dxr3/dxr3videosink.c:
+       * sys/qcam/dark.c:
+         Don't use gtk-doc markers for normal comments. Fix
+         gtk-doc formatting where required.
+
 2005-11-08  Edgard Lima <edgard.lima@indt.org.br>
 
        configure.ac:

diff --git a/ext/tarkin/wavelet.c b/ext/tarkin/wavelet.c
index 77ce9a4..f6aeedc 100644 (file)
--- a/ext/tarkin/wavelet.c
+++ b/ext/tarkin/wavelet.c
@@ -5,7 +5,7 @@
 #include "mem.h"
 #include "wavelet.h"
 
-/**
+/*
  *   (The transform code is in wavelet_xform.c)
  */
 

diff --git a/ext/tarkin/wavelet.h b/ext/tarkin/wavelet.h
index d05bb51..6b7a7af 100644 (file)
--- a/ext/tarkin/wavelet.h
+++ b/ext/tarkin/wavelet.h
@@ -23,7 +23,7 @@ extern Wavelet3DBuf* wavelet_3d_buf_new (uint32_t width, uint32_t height,
 
 extern void wavelet_3d_buf_destroy (Wavelet3DBuf* buf);
 
-/**
+/*
  *  transform buf->data
  *  a_moments is the number of vanishing moments of the analyzing
  *  highpass filter,

diff --git a/gst/mpegaudioparse/gstmpegaudioparse.c b/gst/mpegaudioparse/gstmpegaudioparse.c
index 2602386..0821352 100644 (file)
--- a/gst/mpegaudioparse/gstmpegaudioparse.c
+++ b/gst/mpegaudioparse/gstmpegaudioparse.c
@@ -175,7 +175,7 @@ mp3_type_frame_length_from_header (guint32 header, guint * put_layer,
   return length;
 }
 
-/**
+/*
  * The chance that random data is identified as a valid mp3 header is 63 / 2^18
  * (0.024%) per try. This makes the function for calculating false positives
  *   1 - (1 - ((63 / 2 ^18) ^ GST_MP3_TYPEFIND_MIN_HEADERS)) ^ buffersize)

diff --git a/gst/vbidec/vbidata.c b/gst/vbidec/vbidata.c
index 76f4311..745775b 100644 (file)
--- a/gst/vbidec/vbidata.c
+++ b/gst/vbidec/vbidata.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2002 Billy Biggs <vektor@dumbterm.net>.
  * Copyright (c) 2002 Doug Bell <drbell@users.sourceforge.net>
  *

diff --git a/gst/vbidec/vbiscreen.h b/gst/vbidec/vbiscreen.h
index 9afe284..788211e 100644 (file)
--- a/gst/vbidec/vbiscreen.h
+++ b/gst/vbidec/vbiscreen.h
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2002 Billy Biggs <vektor@dumbterm.net>.
  * Copyright (c) 2002 Doug Bell <drbell@users.sourceforge.net>.
  *

diff --git a/sys/dxr3/ac3_padder.c b/sys/dxr3/ac3_padder.c
index 9e778ba..c9220f7 100644 (file)
--- a/sys/dxr3/ac3_padder.c
+++ b/sys/dxr3/ac3_padder.c
@@ -88,7 +88,7 @@ static const struct frmsize_s frmsizecod_tbl[64] = {
 
 
 /**
- * ac3p_init
+ * ac3p_init:
  * @padder: The padder structure to initialize.
  *
  * Initializes an AC3 stream padder.  This structure can be
@@ -111,7 +111,7 @@ ac3p_init (ac3_padder * padder)
 
 
 /**
- * ac3_push_data
+ * ac3_push_data:
  * @padder The padder structure.
  * @data A pointer to a buffer with new data to parse.  This should 
  * correspond to a new piece of a stream containing raw AC3 data.
@@ -132,7 +132,7 @@ ac3p_push_data (ac3_padder * padder, guchar * data, guint size)
 
 
 /**
- * ac3p_parse
+ * ac3p_parse:
  * @padder The padder structure.
  * 
  * Parses the bytes already pushed into the padder structure (see

diff --git a/sys/dxr3/dxr3audiosink.c b/sys/dxr3/dxr3audiosink.c
index 3ac6521..494aba2 100644 (file)
--- a/sys/dxr3/dxr3audiosink.c
+++ b/sys/dxr3/dxr3audiosink.c
@@ -674,6 +674,7 @@ dxr3audiosink_chain_ac3 (GstPad * pad, GstData * _data)
 #if 0
 /**
  * dxr3audiosink_wait:
+ *
  * Make the sink wait the specified amount of time.
  */
 static void

diff --git a/sys/dxr3/dxr3spusink.c b/sys/dxr3/dxr3spusink.c
index 59d965a..31c1d4c 100644 (file)
--- a/sys/dxr3/dxr3spusink.c
+++ b/sys/dxr3/dxr3spusink.c
@@ -437,6 +437,7 @@ dxr3spusink_change_state (GstElement * element, GstStateChange transition)
 #if 0
 /**
  * dxr3spusink_wait:
+ *
  * Make the sink wait the specified amount of time.
  */
 static void

diff --git a/sys/dxr3/dxr3videosink.c b/sys/dxr3/dxr3videosink.c
index 0832ec5..f100f5a 100644 (file)
--- a/sys/dxr3/dxr3videosink.c
+++ b/sys/dxr3/dxr3videosink.c
@@ -678,6 +678,7 @@ dxr3videosink_change_state (GstElement * element, GstStateChange transition)
 #if 0
 /**
  * dxr3videosink_wait:
+ *
  * Make the sink wait the specified amount of time.
  */
 static void

diff --git a/sys/qcam/dark.c b/sys/qcam/dark.c
index 416d37b..ac462b3 100644 (file)
--- a/sys/qcam/dark.c
+++ b/sys/qcam/dark.c
@@ -24,7 +24,7 @@ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************/
 
-/** Fixdark
+/* Fixdark
        Routine to repair dark current artifacts in qcam output.
        Basic idea: the Qcam CCD suffers from "dark current";
        that is, some of the CCD pixels will leak current under
@@ -120,7 +120,7 @@ read_darkmask()
 */
 
 
-/** fixdark
+/* fixdark
                We first record a list of bad leaky pixels, by making a
                number of exposures in the dark.  master_darkmask holds
                this information.  It's a map of the CCD.