[gstreamermm] doc: fix doxygen documentation

From: Marcin Kolny <mkolny src gnome org>
To: commits-list gnome org
Cc:
Subject: [gstreamermm] doc: fix doxygen documentation
Date: Wed, 28 Sep 2016 21:26:20 +0000 (UTC)
commit 2945d07910fa0da74f9586cda1c9374b4c325136
Author: Marcin Kolny <marcin kolny gmail com>
Date:   Wed Sep 28 23:26:05 2016 +0200

    doc: fix doxygen documentation

 gstreamer/gstreamermm/init.h |   49 +++++--------------------
 gstreamer/src/buffer.hg      |    5 +--
 gstreamer/src/bufferlist.hg  |    2 +-
 gstreamer/src/bus.hg         |    2 +-
 gstreamer/src/caps.hg        |   10 ++---
 gstreamer/src/element.hg     |    4 +-
 gstreamer/src/event.hg       |   15 +++-----
 gstreamer/src/memory.hg      |   12 +++---
 gstreamer/src/message.hg     |   14 ++++----
 gstreamer/src/pad.hg         |   16 +++++----
 gstreamer/src/parse.hg       |    3 --
 gstreamer/src/query.hg       |   81 +++++++++++++++++++++--------------------
 gstreamer/src/registry.hg    |    6 +--
 gstreamer/src/structure.hg   |   19 +++++-----
 gstreamer/src/taglist.hg     |   10 ++---
 gstreamer/src/valuelist.hg   |   11 ++----
 gstreamer/src/videochroma.hg |    8 ++--
 gstreamer/src/videoinfo.hg   |    4 +-
 18 files changed, 115 insertions(+), 156 deletions(-)
---
diff --git a/gstreamer/gstreamermm/init.h b/gstreamer/gstreamermm/init.h
index 87fcbff..51d4eba 100644
--- a/gstreamer/gstreamermm/init.h
+++ b/gstreamer/gstreamermm/init.h
@@ -35,15 +35,7 @@ namespace Gst
  * If this is not an option, your program must initialize the GLib thread
  * system using Glib::thread_init() before any other GLib functions are called
  * and use either Gst::init(), or Gst::init_check() without the command line
- * arguments before calling any gstreamermm functions.  GLib thread
- * initialization can be done as follows:
- *
- * @code
- * if(!Glib::thread_supported())
- *   Glib::thread_init();
- * ...
- * @endcode
- * 
+ * arguments before calling any gstreamermm functions. 
  *
  * Note: This function will terminate your program if it was unable to
  * initialize GStreamer for some reason. If you want your program to fall back,
@@ -65,14 +57,7 @@ void init(int& argc, char**& argv);
  * GLib functions. If this is not an option, your program must initialize the
  * GLib thread system using Glib::thread_init() before any other GLib functions
  * are called and use either this function or Gst::init_check() without the
- * command line arguments before calling any gstreamermm functions.  GLib
- * thread initialization can be done as follows:
- *
- * @code
- * if(!Glib::thread_supported())
- *   Glib::thread_init();
- * ...
- * @endcode
+ * command line arguments before calling any gstreamermm functions.
  *
  * Note: This function will terminate your program if it was unable to
  * initialize GStreamer for some reason. If you want your program to fall
@@ -87,14 +72,7 @@ void init();
  * If this is not an option, your program must initialize the GLib thread
  * system using Glib::thread_init() before any other GLib functions are called
  * and use either Gst::init() or Gst::init_check() without the command line
- * arguments before calling any gstreamermm functions.  GLib thread
- * initialization can be done as follows:
- *
- * @code
- * if(!Glib::thread_supported())
- *   Glib::thread_init();
- * ...
- * @endcode
+ * arguments before calling any gstreamermm functions.
  * 
  * This function will return false if GStreamer could not be initialized for
  * some reason. If you want your program to fail fatally, use Gst::init()
@@ -114,14 +92,7 @@ bool init_check(int& argc, char**& argv);
  * GLib functions. If this is not an option, your program must initialize the
  * GLib thread system using Glib::thread_init() before any other GLib functions
  * are called and use either this function or Gst::init() without the command
- * line arguments before calling any gstreamermm functions.  GLib thread
- * initialization can be done as follows:
- *
- * @code
- * if(!Glib::thread_supported())
- *   Glib::thread_init();
- * ...
- * @endcode
+ * line arguments before calling any gstreamermm functions.
  * 
  * This function will return false if GStreamer could not be initialized for
  * some reason. If you want your program to fail fatally, use Gst::init()
@@ -168,10 +139,10 @@ Glib::OptionGroup get_option_group();
 /**
  * Gets the version number of the GStreamer library.
  *
- * @major: (out): pointer to a guint to store the major version number
- * @minor: (out): pointer to a guint to store the minor version number
- * @micro: (out): pointer to a guint to store the micro version number
- * @nano:  (out): pointer to a guint to store the nano version number
+ * @param major The major version number.
+ * @param minor The minor version number.
+ * @param micro The micro version number.
+ * @param nano The nano version number.
  */
 void version(guint& major, guint& minor, guint& micro, guint& nano);
 
@@ -201,7 +172,7 @@ bool segtrap_is_enabled();
  * Applications might want to disable/enable the SIGSEGV handling of
  * the GStreamer core. See gst_segtrap_is_enabled() for more information.
  *
- * @enabled: whether a custom SIGSEGV handler should be installed.
+ * @param enabled Whether a custom SIGSEGV handler should be installed.
  */
 void segtrap_set_enabled(bool enabled);
 
@@ -223,7 +194,7 @@ bool registry_fork_is_enabled();
  * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
  * information.
  *
- * @enabled: whether rebuilding the registry can use a temporary child helper process.
+ * @param enabled Whether rebuilding the registry can use a temporary child helper process.
  */
 void registry_fork_set_enabled(bool enabled);
 
diff --git a/gstreamer/src/buffer.hg b/gstreamer/src/buffer.hg
index 14b1a6a..645c745 100644
--- a/gstreamer/src/buffer.hg
+++ b/gstreamer/src/buffer.hg
@@ -32,9 +32,8 @@ _WRAP_ENUM(BufferCopyFlags, GstBufferCopyFlags)
 class Memory;
 
 /**
- * SECTION:gstbuffer
- * @short_description: Data-passing buffer type
- * @see_also: #GstPad, #GstMiniObject, #GstMemory, #GstMeta, #GstBufferPool
+ * Data-passing buffer type.
+ * See also: Pad, MiniObject, Memory, Meta, BufferPool
  *
  * Buffers are the basic unit of data transfer in GStreamer. They contain the
  * timing and offset along with other arbitrary metadata that is associated
diff --git a/gstreamer/src/bufferlist.hg b/gstreamer/src/bufferlist.hg
index e3e687a..0e7dad5 100644
--- a/gstreamer/src/bufferlist.hg
+++ b/gstreamer/src/bufferlist.hg
@@ -80,7 +80,7 @@ public:
 
   _WRAP_METHOD(void insert(gint idx, Glib::RefPtr<Gst::Buffer>&& buffer), gst_buffer_list_insert)
 
-  /// A insert() convenience overload. Allows to re-use @buffer parameter after function call.
+  /// A insert() convenience overload. Allows to re-use @a buffer parameter after function call.
   void insert(gint idx, const Glib::RefPtr<Gst::Buffer>& buffer);
 
   /** Call @a slot for each buffer in @a list.
diff --git a/gstreamer/src/bus.hg b/gstreamer/src/bus.hg
index 27f6b39..931dd1b 100644
--- a/gstreamer/src/bus.hg
+++ b/gstreamer/src/bus.hg
@@ -131,7 +131,7 @@ public:
 
   /** Removes bus watch with event source id from main context.
    *
-   * @param The event source id.
+   * @param watch_id The event source id.
    * @return true if removal was succesful, false otherwise.
    */
   bool remove_watch(guint watch_id);
diff --git a/gstreamer/src/caps.hg b/gstreamer/src/caps.hg
index a08ef43..7969cdc 100644
--- a/gstreamer/src/caps.hg
+++ b/gstreamer/src/caps.hg
@@ -83,10 +83,8 @@ public:
   /** Creates a new Gst::Caps that contains one Gst::Structure.
    *
    * @param media_type The media type of the structure.
-   * @param name Field to set.
-   * @param data A value which the field should be set to (this can be any
-   * supported C++ type).
-   * @param ...further_data further data to set in format: name, data.
+   * @param ...further_data further data to set in format: name, data (data
+   * value can be any supported C++ type).
    *
    * @return The new Gst::Caps.
    */
@@ -144,7 +142,7 @@ public:
 #m4 _CONVERSION(`GstStructure*', `const Structure', `Glib::wrap($3, true)')
   /** Finds the structure in caps that has the index @a idx, and returns it.
    *
-   * @param index The index of the structure.
+   * @param idx The index of the structure.
    * @return The Gst::Structure corresponding to index.
    */
   _WRAP_METHOD(const Structure get_structure(guint idx) const, gst_caps_get_structure)
@@ -237,7 +235,7 @@ public:
   _WRAP_METHOD(Glib::RefPtr<Gst::Caps> get_difference(const Glib::RefPtr<const Gst::Caps>& subtrahend_caps) 
const, gst_caps_subtract)
 
   /**
-   * Returns a writable copy of @caps.
+   * Returns a writable copy of @a caps.
    *
    * If there is only one reference count on Gst::Caps object , the caller must be
    * the owner, and so this function will return the caps object unchanged. If on
diff --git a/gstreamer/src/element.hg b/gstreamer/src/element.hg
index d4046c3..c07bb55 100644
--- a/gstreamer/src/element.hg
+++ b/gstreamer/src/element.hg
@@ -135,7 +135,7 @@ class Element : public Gst::Object
   _CLASS_GOBJECT(Element, GstElement, GST_ELEMENT, Gst::Object, GstObject)
 
 public:
-  /** Links this source element to the @dest element.
+  /** Links this source element to the @a dest element.
    * The link must be from source to destination - the other direction will not
    * be tried.  The function looks for existing pads that aren't linked yet. It
    * will request new pads if necessary. Such pads need to be released manually
@@ -288,7 +288,7 @@ public:
   _WRAP_METHOD(bool seek(double rate, Format format, SeekFlags flags, SeekType cur_type, gint64 cur, 
SeekType stop_type, gint64 stop), gst_element_seek)
 
   _WRAP_METHOD(bool send_event(Glib::RefPtr<Gst::Event>&& event), gst_element_send_event)
-  /// A send_event() convenience overload. Allows to re-use @event parameter after function call.
+  /// A send_event() convenience overload. Allows to re-use @a event parameter after function call.
   bool send_event(const Glib::RefPtr<Gst::Event>& event);
 
   _WRAP_METHOD(Glib::RefPtr<Gst::Context> get_context(const Glib::ustring& context_type), 
gst_element_get_context)
diff --git a/gstreamer/src/event.hg b/gstreamer/src/event.hg
index 7ef0463..f70244e 100644
--- a/gstreamer/src/event.hg
+++ b/gstreamer/src/event.hg
@@ -505,15 +505,12 @@ public:
   _WRAP_METHOD(static Glib::RefPtr<Gst::EventQos> create(QOSType type, double proportion, Gst::ClockTimeDiff 
diff, Gst::ClockTime timestamp), gst_event_new_qos)
 
  /**
-  * gst_event_parse_qos:
-  * @event: The event to query
-  * @type: (out): A pointer to store the QoS type in
-  * @proportion: (out): A pointer to store the proportion in
-  * @diff: (out): A pointer to store the diff in
-  * @timestamp: (out): A pointer to store the timestamp in
+  * Gets the type, proportion, diff and timestamp from the qos event. 
   *
-  * Get the type, proportion, diff and timestamp in the qos event. See
-  * gst_event_new_qos() for more information about the different QoS values.
+  * @param type A pointer to store the QoS type in.
+  * @param proportion A pointer to store the proportion in.
+  * @param diff A pointer to store the diff in.
+  * @param timestamp A pointer to store the timestamp in.
   */
   void parse(QOSType& type, double& proportion, Gst::ClockTimeDiff& diff, Gst::ClockTime& timestamp) const;
   _IGNORE(gst_event_parse_qos)
@@ -604,7 +601,7 @@ public:
   SeekType parse_stop_type() const;
 
   /** Parses the stop of a seek event.
-   * @param The stop.
+   * @return The stop.
    */
   gint64 parse_stop() const;
 };
diff --git a/gstreamer/src/memory.hg b/gstreamer/src/memory.hg
index ce895e2..7c1b981 100644
--- a/gstreamer/src/memory.hg
+++ b/gstreamer/src/memory.hg
@@ -57,7 +57,7 @@ class Allocator;
  * memory with an existing memory block at a custom offset and with a custom
  * size.
  *
- * Memory can be efficiently merged when \is_span() returns %TRUE.
+ * Memory can be efficiently merged when is_span() returns %TRUE.
  *
  * Last reviewed on 2016-06-05 (1.8.0)
  */
@@ -69,11 +69,11 @@ class Memory : public MiniObject
 public:
 
   /*
-   * Allocate a new memory block that wraps the given @data.
+   * Allocate a new memory block that wraps the given @a data.
    *
    * @param flags: Gst::MemoryFlags.
    * @param data Data to wrap.
-   * @param maxsize Allocated size of @data.
+   * @param maxsize Allocated size of @a data.
    * @param offset Offset in @data.
    * @param size Size of valid data.
    *
@@ -115,9 +115,9 @@ public:
   _WRAP_METHOD(void init(Gst::MemoryFlags flags, const Glib::RefPtr<Gst::Allocator>& allocator, const 
Glib::RefPtr<Gst::Memory>& parent, gsize maxsize, gsize align, gsize offset, gsize size), gst_memory_init)
   _WRAP_METHOD(gsize get_sizes(gsize& offset, gsize& maxsize), gst_memory_get_sizes)
 
-  /** Create a Gst::Memory object that is mapped with @flags. If @mem is mappable
-   * with @flags, this function returns the mapped @mem directly. Otherwise a
-   * mapped copy of @mem is returned.
+  /** Create a Gst::Memory object that is mapped with @a flags. If @a mem is mappable
+   * with @a flags, this function returns the mapped @a mem directly. Otherwise a
+   * mapped copy of @a mem is returned.
    *
    * @param info Pointer for info.
    * @param flags Mapping flags.
diff --git a/gstreamer/src/message.hg b/gstreamer/src/message.hg
index c60be57..08a597a 100644
--- a/gstreamer/src/message.hg
+++ b/gstreamer/src/message.hg
@@ -971,12 +971,12 @@ public:
   /** Set the QoS stats representing the history of the current continuous pipeline
    * playback period.
    *
-   * When @format is Gst::FORMAT_UNDEFINED both @dropped and @processed are
-   * invalid. Values of -1 for either @processed or @dropped mean unknown values.
+   * When @a format is Gst::FORMAT_UNDEFINED both @a dropped and @a processed are
+   * invalid. Values of -1 for either @a processed or @a dropped mean unknown values.
    *
    * MT safe.
    *
-   * @param format Units of the 'processed' and 'dropped' fields. Video sinks and video
+   * @param format Units of the @a processed and @a dropped fields. Video sinks and video
    *    filters will use Gst::FORMAT_BUFFERS (frames). Audio sinks and audio filters
    *    will likely use Gst::FORMAT_DEFAULT (samples).
    * @param processed Total number of units correctly processed since the last state
@@ -1014,7 +1014,7 @@ public:
    *     the deadline.
    * @param proportion Long term prediction of the ideal rate
    *     relative to normal rate to get optimal quality.
-   * @param An element dependent integer value that
+   * @param quality An element dependent integer value that
    *     specifies the current quality level of the element. The default
    *     maximum quality is 1000000.
    *
@@ -1037,8 +1037,8 @@ public:
    *
    * MT_safe.
    *
-   * When @format is Gst::FORMAT_UNDEFINED both @dropped and @processed are
-   * invalid. Values of -1 for either @processed or @dropped mean unknown values.
+   * When @a format is Gst::FORMAT_UNDEFINED both @a dropped and @a processed are
+   * invalid. Values of -1 for either @a processed or @a dropped mean unknown values.
    */
   void parse_stats(Gst::Format& format, guint64& processed, guint64& dropped) const;
   _IGNORE(gst_message_parse_qos_stats)
@@ -1181,7 +1181,7 @@ public:
   _WRAP_METHOD(static Glib::RefPtr<Gst::MessageProgress> create(const Glib::RefPtr<Gst::Object>& src,
                                                                Gst::ProgressType type, const Glib::ustring& 
code, const Glib::ustring& text), gst_message_new_progress)
 
-  /** Parses the progress @type, @code and @text.
+  /** Parses the progress @a type, @a code and @a text.
    *
    * @param type A Gst::ProgressType.
    * @param code A code.
diff --git a/gstreamer/src/pad.hg b/gstreamer/src/pad.hg
index d1c17e5..cf0d78e 100644
--- a/gstreamer/src/pad.hg
+++ b/gstreamer/src/pad.hg
@@ -130,7 +130,7 @@ public:
   /** Creates a new pad with the given name in the given direction.
    *
    * @param name The name of the new pad.
-   * @param direction The GstPadDirection of the pad.
+   * @param dir The PadDirection of the pad.
    * @return A new Gst::Pad, or a null RefPtr<> in case of an error. MT safe.
    */
   _WRAP_CREATE(const Glib::ustring& name, PadDirection dir)
@@ -138,15 +138,15 @@ public:
   /** Creates a new pad with a guaranteed unique name (across all pads) in the
    * given direction.
    *
-   * @param direction The GstPadDirection of the pad.
+   * @param dir The PadDirection of the pad.
    * @return A new Gst::Pad, or a null RefPtr<> in case of an error. MT safe.
    */
   _WRAP_CREATE(PadDirection dir)
 
   /** Creates a new pad with the given name from the given template.
    *
-   * @param templ The pad template to use.
-   * @param name The name of the element.
+   * @param pad_template The pad template to use.
+   *
    * @return A new Gst::Pad, or a null RefPtr<> in case of an error.
    * @throw std::runtime_error if construction fails.
    */
@@ -155,7 +155,9 @@ public:
   /** Creates a new pad with a guaranteed unique name (across all pads) from
    * the given template.
    *
-   * @param templ The pad template to use.
+   * @param pad_template The pad template to use.
+   * @param name The name of the pad.
+   * 
    * @return A new Gst::Pad, or a null RefPtr<> in case of an error.
    * @throw std::runtime_error if construction fails.
    */
@@ -242,7 +244,7 @@ public:
 
   _WRAP_METHOD(bool push_event(Glib::RefPtr<Gst::Event>&& event), gst_pad_push_event)
 
-  /// A push_event() convenience overload. Allows to re-use @event parameter after function call.
+  /// A push_event() convenience overload. Allows to re-use @a event parameter after function call.
   bool push_event(const Glib::RefPtr<Gst::Event>& event);
 
   /** Pulls a buffer from the peer pad.  This function will first trigger the
@@ -271,7 +273,7 @@ public:
 
   _WRAP_METHOD(bool send_event(Glib::RefPtr<Gst::Event>&& event), gst_pad_send_event)
 
-  /// A send_event() convenience overload. Allows to re-use @event parameter after function call.
+  /// A send_event() convenience overload. Allows to re-use @a event parameter after function call.
   bool send_event(const Glib::RefPtr<Gst::Event>& event);
 
   _WRAP_METHOD(bool activate_mode(Gst::PadMode mode, bool active = true), gst_pad_activate_mode)
diff --git a/gstreamer/src/parse.hg b/gstreamer/src/parse.hg
index a61f456..71b99a5 100644
--- a/gstreamer/src/parse.hg
+++ b/gstreamer/src/parse.hg
@@ -55,7 +55,6 @@ public:
    * is set. In this case there was a recoverable parsing error and you can try
    * to play the pipeline.
    * @param pipeline_description The command line describing the pipeline.
-   * @param error The error message in case of an erroneous pipeline.
    * @return A new element on success, a null RefPtr<> on failure. If more than
    * one toplevel element is specified by the pipeline_description, all
    * elements are put into a Gst::Pipeline, which than is returned.
@@ -67,7 +66,6 @@ public:
   /** Create a new element based on command line syntax. An error does not
    * mean that the pipeline could not be constructed.
    * @param argv null-terminated array of arguments.
-   * @param error Will contain an error message if an erroneuos pipeline is
    * specified. 
    * @return A new element on success and null on failure.
    * @throw Gst::CoreError
@@ -87,7 +85,6 @@ public:
    * @param bin_description Command line describing the bin.
    * @param ghost_unconnected_pads Whether to automatically create ghost pads
    * for unconnected source or sink pads within the bin.
-   * @param err Where to store the error message in case of an error.
    * @return A newly-created bin, or a null RefPtr<> if an error occurred.
    * @throw Gst::CoreError
    * @throw Gst::ParseError
diff --git a/gstreamer/src/query.hg b/gstreamer/src/query.hg
index aa21a0c..5d4c54b 100644
--- a/gstreamer/src/query.hg
+++ b/gstreamer/src/query.hg
@@ -58,13 +58,13 @@ namespace Enums
 
 /** Gets a printable name for the given query type.
  *
- * @param query The query type.
+ * @param type The query type.
  * @return The name of the query.
  */
 Glib::ustring get_name(QueryType type);
 _IGNORE(gst_query_type_get_name)
 
-/** Gets the Gst::QueryTypeFlags associated with @type.
+/** Gets the Gst::QueryTypeFlags associated with @a type.
  *
  * @param type a Gst::QueryType.
  * @return a Gst::QueryTypeFlags;
@@ -74,7 +74,7 @@ _IGNORE(gst_query_type_get_flags)
 
 /** Gets the unique quark for the given query type.
  *
- * @param query The query type.
+ * @param type The query type.
  * @return The quark associated with the query type.
  */
 Glib::QueryQuark get_quark(QueryType type);
@@ -451,7 +451,7 @@ public:
    * @param segment_start The segment_start to set.
    * @param segment_end The segment_end to set.
    */
-  void set(Format format, bool seeakable, gint64 segment_start, gint64 segment_end);
+  void set(Format format, bool seekable, gint64 segment_start, gint64 segment_end);
 
   /** Parse a seeking query, writing the format into format, and other results
    * into the passed parameters.  Use the other parse() methods for parsing
@@ -716,8 +716,8 @@ public:
    */
   guint get_n_buffering_ranges() const;
 
-  /** Set the buffering-ranges array field in @query. The current last
-   * start position of the array should be inferior to @start.
+  /** Set the buffering-ranges array field in @a query. The current last
+   * start position of the array should be inferior to @a start.
    * @param start start position of the range.
    * @param stop stop position of the range.
    * @return a bool indicating if the range was added or not.
@@ -725,7 +725,7 @@ public:
   bool add_buffering_range(gint64 start, gint64 stop);
 
   /** Parse an available query and get the start and stop values stored
-   * at the @index of the buffered ranges array.
+   * at the @a index of the buffered ranges array.
    * @param index position in the buffered-ranges array to read.
    * @param start the start position to set, or NULL.
    * @param stop the stop position to set, or NULL.
@@ -754,8 +754,8 @@ public:
    * the CAPS query should return the most specific caps it reasonably can, since this
    * helps with autoplugging.
    *
-   * The @filter is used to restrict the result caps, only the caps matching
-   * @filter should be returned from the CAPS query. Specifying a filter might
+   * The @a filter is used to restrict the result caps, only the caps matching
+   * @a filter should be returned from the CAPS query. Specifying a filter might
    * greatly reduce the amount of processing an element needs to do.
    * @param filter a filter.
    * @return The new Gst::QureyCaps.
@@ -763,19 +763,19 @@ public:
   static Glib::RefPtr<Gst::QueryCaps>
     create(const Glib::RefPtr<Gst::Caps>& filter);
 
-  /** Get the filter from the caps @query. The caps remains valid as long as
-   * @query remains valid.
+  /** Get the filter from the caps @a query. The caps remains valid as long as
+   * @a query remains valid.
    * @return caps filter.
    */
   Glib::RefPtr<Gst::Caps> parse() const;
 
-  /** Get the caps result from @query. The caps remains valid as long as
-   * @query remains valid.
+  /** Get the caps result from @a query. The caps remains valid as long as
+   * @a query remains valid.
    * @return a pointer to the caps.
    */
   Glib::RefPtr<Gst::Caps> parse_caps_result() const;
 
-  /** Set the @caps result in @query.
+  /** Set the @a caps result in @a query.
    * @param caps a pointer to the caps.
    */
   void set_caps_result(const Glib::RefPtr<Gst::Caps>& caps);
@@ -809,31 +809,32 @@ public:
    */
   void set(Gst::SchedulingFlags flags, gint minsize, gint maxsize, gint align);
 
-  /** Add @mode as aone of the supported scheduling modes to @query.
-   * @param a Gst::PadMode.
+  /** Add @a mode as aone of the supported scheduling modes to @a query.
+   *
+   * @param mode A Gst::PadMode.
    */
   void add_scheduling_mode(Gst::PadMode mode);
 
   /** Retrieve the number of values currently stored in the
    * scheduling mode array of the query's structure.
-   * @return the scheduling mode array size as a @guint.
+   * @return the scheduling mode array size as a guint.
    */
   guint get_n_scheduling_modes() const;
 
   /** Parse an available query and get the scheduling mode
-   * at @index of the scheduling modes array.
+   * at @a index of the scheduling modes array.
    * @param index position in the scheduling modes array to read
-   * @return a Gst::PadMode of the scheduling mode at @index.
+   * @return a Gst::PadMode of the scheduling mode at @a index.
    */
   Gst::PadMode parse_nth_scheduling_mode(guint index) const;
 
-  /** Check if @query has scheduling mode set.
+  /** Check if @a query has scheduling mode set.
    * @param mode the scheduling mode.
-   * @return true when @mode is in the list of scheduling modes.
+   * @return true when @a mode is in the list of scheduling modes.
    */
   bool has_scheduling_mode(Gst::PadMode mode) const;
 
-  /** Check if @query has scheduling mode set and @flags is set in
+  /** Check if @a query has scheduling mode set and @a flags is set in
    * query scheduling flags.
    * @param mode the scheduling mode.
    * @param flags Gst::SchedulingFlags.
@@ -854,8 +855,8 @@ public:
   static Glib::RefPtr<Gst::QueryAllocation>
     create(const Glib::RefPtr<Gst::Caps>& caps, bool need_pool);
 
-  /** Parse an allocation query, writing the requested caps in @caps and
-   * whether a pool is needed in @need_pool, if the respective parameters
+  /** Parse an allocation query, writing the requested caps in @a caps and
+   * whether a pool is needed in @a need_pool, if the respective parameters
    * are non-NULL.
    * @param caps the Gst::Caps.
    * @param need_pool whether a Gst::BufferPool is needed.
@@ -868,12 +869,12 @@ public:
    */
   guint get_n_allocation_pools() const;
 
-  /** Remove the allocation pool at @index of the allocation pool array.
+  /** Remove the allocation pool at @a index of the allocation pool array.
    * @param index position in the allocation pool array to remove.
    */
   void remove_nth_allocation_pool(guint index);
 
-  /** Add @allocator and its @params as a supported memory allocator.
+  /** Add @a allocator and its @a params as a supported memory allocator.
    * @param allocator the memory allocator.
    * @param params a Gst::AllocationParams.
    */
@@ -891,7 +892,7 @@ public:
   guint get_n_allocation_params() const;
 
   /** Parse an available query and get the alloctor and its params
-   * at @index of the allocator array.
+   * at @a index of the allocator array.
    * @param index position in the allocator array to read.
    * @param allocator variable to hold the result.
    * @param params parameters for the allocator.
@@ -899,19 +900,19 @@ public:
   void parse_nth_allocation_param(guint index, Glib::RefPtr<Gst::Allocator>& allocator, 
Gst::AllocationParams& params) const;
 
   /** Parse an available query and get the alloctor and its params
-   * at @index of the allocator array.
+   * at @a index of the allocator array.
    * @param index position in the allocator array to set.
    * @param allocator new allocator to set.
    * @param params parameters for the allocator.
    */
   void set_nth_allocation_param(guint index, const Glib::RefPtr<Gst::Allocator>& allocator, const 
Gst::AllocationParams& params);
 
-  /** Remove the allocation param at @index of the allocation param array.
+  /** Remove the allocation param at @a index of the allocation param array.
    * @param index position in the allocation param array to remove
    */
   void remove_nth_allocation_param(guint index);
 
-  /** Add @api with @params as one of the supported metadata API to @query.
+  /** Add @a api with @a params as one of the supported metadata API to @a query.
    * @param api the metadata API.
    * @param params API specific parameters.
    */
@@ -924,23 +925,23 @@ public:
   guint get_n_allocation_metas() const;
 
   /** Parse an available query and get the metadata API
-   * at @index of the metadata API array.
+   * at @a index of the metadata API array.
    * @param index position in the metadata API array to read.
    * @param params API specific flags.
    */
   GType parse_nth_allocation_meta(guint index, Gst::Structure& params) const;
 
-  /** Remove the metadata API at @index of the metadata API array.
+  /** Remove the metadata API at @a index of the metadata API array.
    * @param index positon in the metadata API array to remove.
    */
   void remove_nth_allocation_meta(guint index);
 
-  /** Check if @query has metadata @api set. When this function returns TRUE,
-   * @index will contain the index where the requested API and the flags can be
+  /** Check if @a query has metadata @a api set. When this function returns TRUE,
+   * @a index will contain the index where the requested API and the flags can be
    * found.
    * @param api the metadata API.
    * @param index the index
-   * @return true when @api is in the list of metadata.
+   * @return true when @a api is in the list of metadata.
    */
   bool find_allocation_meta(GType api, guint& index) const;
 };
@@ -957,7 +958,7 @@ public:
    */
   static Glib::RefPtr<Gst::QueryUri> create();
 
-  /** Parse an URI query, writing the URI into @uri as a newly
+  /** Parse an URI query, writing the URI into @a uri as a newly
    * allocated string, if the respective parameters are non-NULL.
    * Free the string with g_free() after usage.
    * @return the storage for the current URI.
@@ -985,23 +986,23 @@ public:
 class QueryAcceptCaps : public Query
 {
 public:
-  /** Constructs a new query object for querying if @caps are accepted.
+  /** Constructs a new query object for querying if @a caps are accepted.
    * @return a new Gst::Query.
    */
   static Glib::RefPtr<Gst::QueryAcceptCaps> create(const Glib::RefPtr<Gst::Caps>& caps);
 
-  /** Get the caps from @query. The caps remains valid as long as @query remains
+  /** Get the caps from @a query. The caps remains valid as long as @a query remains
     * valid.
     * @return a caps.
     */
   Glib::RefPtr<Gst::Caps> parse_accept_caps() const;
 
-  /** Parse the result from @query and store in @result.
+  /** Parse the result from @a query and store in @a result.
    * @return location for the result.
    */
   bool parse_accept_caps_result() const;
 
-  /** Set @result as the result for the @query.
+  /** Set @a result as the result for the @a query.
    * @param result the result to set.
    */
   void set_accept_caps_result(bool result);
diff --git a/gstreamer/src/registry.hg b/gstreamer/src/registry.hg
index 6c8ccc4..23a5c47 100644
--- a/gstreamer/src/registry.hg
+++ b/gstreamer/src/registry.hg
@@ -114,7 +114,7 @@ public:
 
   _WRAP_METHOD(bool add_plugin(Glib::RefPtr<Gst::Plugin>&& plugin), gst_registry_add_plugin)
 
-  /// A add_plugin() convenience overload. Allows to re-use @plugin parameter after function call.
+  /// A add_plugin() convenience overload. Allows to re-use @a plugin parameter after function call.
   void add_plugin(const Glib::RefPtr<Gst::Plugin>& plugin);
   /** Runs a filter against all plugins in the registry and returns a List with
    * the results. If the first flag is set, only the first match is returned
@@ -143,7 +143,6 @@ public:
    * returns a List with the results. If the first flag is set, only the first
    * match is returned (as a list with a single object).
    *
-   * @param registry Registry to query.
    * @param filter The filter to use.
    * @param first Only return first match.
    * @return A list of Gst::PluginFeature. MT safe.
@@ -155,7 +154,6 @@ public:
    * returns a List with the results. If the first flag is set, only the first
    * match is returned (as a list with a single object).
    *
-   * @param registry Registry to query.
    * @param filter The filter to use.
    * @param first Only return first match.
    * @return A list of Gst::PluginFeature. MT safe.
@@ -180,7 +178,7 @@ public:
   /// h2def.py script can't detect that case, so methods have to be ignored manually.
   _IGNORE(gst_registry_add_path, gst_registry_get_path_list)
 
-  /// A add_feature() convenience overload. Allows to re-use @feature parameter after function call.
+  /// A add_feature() convenience overload. Allows to re-use @a feature parameter after function call.
   void add_feature(const Glib::RefPtr<Gst::PluginFeature>& feature);
 
   static Glib::RefPtr<Gst::Registry> get();
diff --git a/gstreamer/src/structure.hg b/gstreamer/src/structure.hg
index 49eb5f1..6028a03 100644
--- a/gstreamer/src/structure.hg
+++ b/gstreamer/src/structure.hg
@@ -66,7 +66,7 @@ class Structure
   _IGNORE(gst_structure_copy, gst_structure_free, gst_structure_set_parent_refcount)
 
 public:
-  /** Creates a Structure with the given @name. Parses the list of variable
+  /** Creates a Structure with the given @a name. Parses the list of variable
    * arguments and sets fields to the values listed. Variable arguments
    * should be passed as field name and value
    */
@@ -76,7 +76,7 @@ public:
   /** Creates a Gst::Structure from a string representation.
    *
    * @param the_string A string representation of a Gst::Structure. See to_string().
-   * @returns A Structure. This will be invalid (see operator=) when the string 
+   * @return A Structure. This will be invalid (see operator=) when the string 
    * could not be parsed.
    */
   static Structure create_from_string(const Glib::ustring& the_string);
@@ -131,7 +131,7 @@ public:
    */
   void get_field(const Glib::ustring& fieldname, Glib::ValueBase& value) const;
 
-  /** Get the value of the field with name @fieldname.
+  /** Get the value of the field with name @a fieldname.
    *
    * @param fieldname The name of the field to get.
    * @param value The Value class in which to store the value.
@@ -161,7 +161,7 @@ public:
   bool get_field(const Glib::ustring& fieldname, GType enumtype, int& value) const;
   _IGNORE(gst_structure_get_enum)
 
-  /** Gets the value of field @a fieldname into DataType @value.
+  /** Gets the value of field @a fieldname into DataType @a value.
    * The caller is responsible for making sure the field exists and has the
    * correct type.
    *
@@ -206,7 +206,7 @@ public:
     gst_structure_set_valist
   )
 
-  /** Sets the field with name @fieldname to value. If the field does not
+  /** Sets the field with name @a fieldname to value. If the field does not
    * exist, it is created. If the field exists, the previous value is replaced
    * and freed.
    *
@@ -216,7 +216,7 @@ public:
   template<typename DataType>
   void set_field(const Glib::ustring& fieldname, const Glib::Value<DataType>& value);
 
-  /** Sets the field with name @fieldname to value. If the field does not
+  /** Sets the field with name @a fieldname to value. If the field does not
    * exist, it is created. If the field exists, the previous value is replaced
    * and freed.
    *
@@ -225,12 +225,13 @@ public:
    */
   void set_field(const Glib::ustring& fieldname, const char* value);
 
-  /** Sets the fields with name @fieldname to values. If one of the fields does not
+  /** Sets the fields with name @a fieldname to values. If one of the fields does not
    * exist, it is created. If the field exists, the previous value is replaced
    * and freed.
    *
    * @param fieldname The name of the field to set.
    * @param value The value to set the field to.
+   * @param further_data List of pairs of the format: fieldname, value.
    */
   template<class DataType, class ...DataTypes>
   void set_fields(const Glib::ustring & fieldname, const DataType& value, DataTypes ...further_data);
@@ -253,7 +254,7 @@ public:
    */
   void set_field(const Glib::ustring& fieldname, GType enumtype, int value);
 
-  /** Sets the field with name @fieldname field to the DataType @value.
+  /** Sets the field with name @a fieldname field to the DataType @a value.
    * If the field does not exist, it is created. If the field exists,
    * the previous value is replaced and freed. Please note that when setting
    * fields to special types such as Gst::Fourcc and Gst::Fraction and
@@ -320,7 +321,7 @@ public:
    * @param target The target value of the fixation.
    * @return true If the structure could be fixated.
    */
-  bool fixate_nearest_fraction(const Glib::ustring& name, const Gst::Fraction& target);
+  bool fixate_nearest_fraction(const Glib::ustring& field_name, const Gst::Fraction& target);
   _IGNORE(gst_structure_fixate_field_nearest_fraction)
 
   //Variable argument functions are ignored.
diff --git a/gstreamer/src/taglist.hg b/gstreamer/src/taglist.hg
index 914192b..50c1274 100644
--- a/gstreamer/src/taglist.hg
+++ b/gstreamer/src/taglist.hg
@@ -413,8 +413,7 @@ public:
   /** Sets the value for the given tag using the specified mode.
    *
    * @param tag The tag name.
-   * @param data A value which the tag should be set to (this can be any
-   * supported C++ type).
+   * @param date A date.
    * @param mode The merge mode to use.
    */
   void add(Tag tag, const Glib::Date& date, TagMergeMode mode = TAG_MERGE_PREPEND);
@@ -422,8 +421,7 @@ public:
   /** Sets the value for the given tag using the specified mode.
    *
    * @param tag The tag name.
-   * @param data A value which the tag should be set to (this can be any
-   * supported C++ type).
+   * @param date A date.
    * @param mode The merge mode to use.
    */
   void add(const Glib::ustring& tag, const Glib::Date& date, TagMergeMode mode = TAG_MERGE_PREPEND);
@@ -476,7 +474,7 @@ dnl See .ccg implementation for how this conversion works.
   /** Gets the value that is at the given index for the given tag.
    * @param tag The tag to read out.
    * @param index Number of entry to read out.
-   * @@param The Glib::ValueBase to store the value in.
+   * @param dest The Glib::ValueBase to store the value in.
    * @return true if tag was available and had right number of entries, false
    * otherwise.
    */
@@ -486,7 +484,7 @@ dnl See .ccg implementation for how this conversion works.
   /** Gets the value that is at the given index for the given tag.
    * @param tag The tag to read out.
    * @param index Number of entry to read out.
-   * @@param The Glib::ValueBase to store the value in.
+   * @param dest The Glib::ValueBase to store the value in.
    * @return true if tag was available and had right number of entries, false
    * otherwise.
    */
diff --git a/gstreamer/src/valuelist.hg b/gstreamer/src/valuelist.hg
index 82eb897..228c0b2 100644
--- a/gstreamer/src/valuelist.hg
+++ b/gstreamer/src/valuelist.hg
@@ -42,7 +42,6 @@ public:
 
   /** Gets the number of values contained in @a value.
    *
-   * @param value A Value of type Gst::TYPE_LIST.
    * @return The number of values.
    */
   guint size() const;
@@ -56,17 +55,15 @@ public:
    */
   bool get(guint index, Glib::ValueBase& value) const;
 
-  /** Appends @a append_value to the GstValueList in @a value.
+  /** Appends @a value to the ValueList.
    *
-   * @param value A Value of type Gst::TYPE_LIST.
-   * @param append_value The value to append.
+   * @param value The value to append.
    */
   Gst::ValueList& append(const Glib::ValueBase& value);
 
-  /** Prepends @a prepend_value to the GstValueList in @a value.
+  /** Prepends @a value to the ValueList.
    *
-   * @param value A Value of type Gst::TYPE_LIST.
-   * @param prepend_value The value to prepend.
+   * @param value The value to prepend.
    */
   Gst::ValueList& prepend(const Glib::ValueBase& value);
 
diff --git a/gstreamer/src/videochroma.hg b/gstreamer/src/videochroma.hg
index fcdef38..17c9af8 100644
--- a/gstreamer/src/videochroma.hg
+++ b/gstreamer/src/videochroma.hg
@@ -35,15 +35,15 @@ namespace Gst
 
 namespace Enums
 {
-/** Converts @site to its string representation.
+/** Converts @a site to its string representation.
  * @param site A Gst::VideoChromaSite.
- * @return a string describing @site.
+ * @return a string describing @a site.
  */
 Glib::ustring get_name(VideoChromaSite site);
 
-/** Convert @s to a Gst::VideoChromaSite.
+/** Convert @a s to a Gst::VideoChromaSite.
  * @param s A chromasite string.
- * @return A Gst::VideoChromaSite or Gst::VIDEO_CHROMA_SITE_UNKNOWN when @s does
+ * @return A Gst::VideoChromaSite or Gst::VIDEO_CHROMA_SITE_UNKNOWN when @a s does
  * not contain a valid chroma description.
  */
 VideoChromaSite video_chroma_site_from_string(const Glib::ustring& s);
diff --git a/gstreamer/src/videoinfo.hg b/gstreamer/src/videoinfo.hg
index e23a333..6e552fe 100644
--- a/gstreamer/src/videoinfo.hg
+++ b/gstreamer/src/videoinfo.hg
@@ -53,8 +53,8 @@ public:
 
   /** This constructor allows to wrap both dynamic and static allocated
     * GstVideoInfo object. If castitem is either static allocated or
-    * dynamic allocated, but will be freed somewhere else, @take_ownership
-    * should be set to false. If @take_ownership is set to true, castitem
+    * dynamic allocated, but will be freed somewhere else, @a take_ownership
+    * should be set to false. If @a take_ownership is set to true, castitem
     * is freed in VideoInfo destructor.
     */
   VideoInfo(GstVideoInfo* castitem, bool take_ownership);
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]