[gstreamermm/wip/jtojnar/build-fixes: 1/3] Fix documentation of ValueList methods




commit f675074707002c5862fd56b3fb935fa893be9e7a
Author: Jan Tojnar <jtojnar gmail com>
Date:   Tue May 3 02:25:15 2022 +0200

    Fix documentation of ValueList methods
    
    The API is slightly different from C:
     - We use in-out argument for getting the value at given index.
     - There is no need for “self” argument.

 gstreamer/src/valuelist.hg | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
---
diff --git a/gstreamer/src/valuelist.hg b/gstreamer/src/valuelist.hg
index 228c0b2..b9cd2b5 100644
--- a/gstreamer/src/valuelist.hg
+++ b/gstreamer/src/valuelist.hg
@@ -40,18 +40,18 @@ public:
 
 public:
 
-  /** Gets the number of values contained in @a value.
+  /** Gets the number of values contained in the list.
    *
    * @return The number of values.
    */
   guint size() const;
   
-  /** Gets the value that is a member of the list contained in @a value and
-   * has the index @a index.
+  /** Sets @a value to the value is the member of the list
+   * at the index @a index.
    *
-   * @param value A Value of type Gst::TYPE_LIST.
    * @param index Index of value to get from the list.
-   * @return The value at the given index.
+   * @param value The value at the given index.
+   * @return Whether the list contains a value at given index.
    */
   bool get(guint index, Glib::ValueBase& value) const;
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]