fix docs

Original commit message from CVS:
fix docs

diff --git a/ChangeLog b/ChangeLog
index d080dda..a210599 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2005-12-05  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * docs/gst/gstreamer-sections.txt:
+       * docs/libs/tmpl/gstdataprotocol.sgml:
+       * docs/random/thomasvs/TODO:
+       * gst/gstutils.c:
+       * gst/gstutils.h:
+         fix docs
+
 2005-12-05  Andy Wingo  <wingo@pobox.com>
 
        patch by: Wim Taymans <wim@fluendo.com>

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 1285bbc..12534c1 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -2012,9 +2012,10 @@ gst_util_set_object_arg
 gst_util_set_value_from_string
 <SUBSECTION Private>
 GST_HAVE_UNALIGNED_ACCESS
+gst_util_guint64_to_gdouble
+gst_util_gdouble_to_guint64
 </SECTION>
 
-
 <SECTION>
 <FILE>gstvalue</FILE>
 <TITLE>GStreamer GValue types</TITLE>

diff --git a/docs/random/thomasvs/TODO b/docs/random/thomasvs/TODO
index 52701a9..fce3d74 100644 (file)
--- a/docs/random/thomasvs/TODO
+++ b/docs/random/thomasvs/TODO
@@ -1,5 +1,3 @@
 GSTREAMER
 ---------
-- make plugins be documented just like in the plugins modules
-- do not link against them directly for the docs build
 - gst-i18n-lib.h is included funnily from base classes and elements

diff --git a/gst/gstutils.c b/gst/gstutils.c
index faa87de..ebc5141 100644 (file)
--- a/gst/gstutils.c
+++ b/gst/gstutils.c
@@ -298,18 +298,12 @@ gst_util_set_object_arg (GObject * object, const gchar * name,
 }
 
 /* work around error C2520: conversion from unsigned __int64 to double
- * not implemented, use signed __int64 */
-
-/**
- * gst_util_guint64_to_gdouble:
- * @value: the #guint64 value to convert
+ * not implemented, use signed __int64
  *
- * Convert @value to a gdouble. This is implemented as a function
- * because on some platforms a 64bit int to double conversion is
- * not defined/implemented.
- *
- * Returns: @value converted to a #gdouble.
+ * These are implemented as functions because on some platforms a 64bit int to
+ * double conversion is not defined/implemented.
  */
+
 gdouble
 gst_util_guint64_to_gdouble (guint64 value)
 {
@@ -319,16 +313,6 @@ gst_util_guint64_to_gdouble (guint64 value)
     return (gdouble) ((gint64) value);
 }
 
-/**
- * gst_util_gdouble_to_guint64:
- * @value: the #gdouble value to convert
- *
- * Convert @value to a guint64. This is implemented as a function
- * because on some platforms a double to guint64 conversion is not
- * defined/implemented.
- *
- * Returns: @value converted to a #guint64.
- */
 guint64
 gst_util_gdouble_to_guint64 (gdouble value)
 {

diff --git a/gst/gstutils.h b/gst/gstutils.h
index 3a75c9e..46848ca 100644 (file)
--- a/gst/gstutils.h
+++ b/gst/gstutils.h
@@ -54,8 +54,8 @@ gdouble         gst_util_guint64_to_gdouble     (guint64 value);
  * Returns: @value converted to a #guint64.
  */
 #ifdef WIN32
-#define         gst_gdouble_to_guint64(v)       gst_util_gdouble_to_guint64(v)
-#define         gst_guint64_to_gdouble(v)       gst_util_guint64_to_gdouble(v)
+#define         gst_gdouble_to_guint64(value)   gst_util_gdouble_to_guint64(value)
+#define         gst_guint64_to_gdouble(value)   gst_util_guint64_to_gdouble(value)
 #else
 #define         gst_gdouble_to_guint64(value)   ((guint64) (value))
 #define         gst_guint64_to_gdouble(value)   ((gdouble) (value))