[rygel] core: Correct return to @return in valadoc



commit a702ffb079a530d00e6268e4bfd74d366b76a633
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Jun 26 16:19:07 2012 +0200

    core: Correct return to @return in valadoc

 src/librygel-core/rygel-media-container.vala      |    4 ++--
 src/librygel-core/rygel-plugin-loader.vala        |    2 +-
 src/librygel-core/rygel-searchable-container.vala |   13 +++++--------
 src/librygel-core/rygel-writable-container.vala   |    4 ++--
 4 files changed, 10 insertions(+), 13 deletions(-)
---
diff --git a/src/librygel-core/rygel-media-container.vala b/src/librygel-core/rygel-media-container.vala
index a361abe..faa84b2 100644
--- a/src/librygel-core/rygel-media-container.vala
+++ b/src/librygel-core/rygel-media-container.vala
@@ -108,7 +108,7 @@ public abstract class Rygel.MediaContainer : MediaObject {
      * @param max_count maximum number of objects to return
      * @param cancellable optional cancellable for this operation
      *
-     * return A list of media objects.
+     * @return A list of media objects.
      */
     public async abstract MediaObjects? get_children (uint         offset,
                                                       uint         max_count,
@@ -123,7 +123,7 @@ public abstract class Rygel.MediaContainer : MediaObject {
      * @param cancellable optional cancellable for this operation
      * @param callback function to call when result is ready
      *
-     * return the found media object.
+     * @return the found media object.
      */
     public async abstract MediaObject? find_object (string       id,
                                                     Cancellable? cancellable)
diff --git a/src/librygel-core/rygel-plugin-loader.vala b/src/librygel-core/rygel-plugin-loader.vala
index 6e79d23..a5569dc 100644
--- a/src/librygel-core/rygel-plugin-loader.vala
+++ b/src/librygel-core/rygel-plugin-loader.vala
@@ -69,7 +69,7 @@ public class Rygel.PluginLoader : Object {
      *
      * @param name the name of plugin to check for.
      *
-     * return true if plugin is disabled, false if not.
+     * @return true if plugin is disabled, false if not.
      */
     public bool plugin_disabled (string name) {
         var enabled = true;
diff --git a/src/librygel-core/rygel-searchable-container.vala b/src/librygel-core/rygel-searchable-container.vala
index 8334c42..8934e6f 100644
--- a/src/librygel-core/rygel-searchable-container.vala
+++ b/src/librygel-core/rygel-searchable-container.vala
@@ -33,16 +33,13 @@ public interface Rygel.SearchableContainer : MediaContainer {
      * Recursively searches for all media objects that satisfy the given search
      * expression in this container.
      *
-     * @param expression the search expression or `null` for wildcard
+     * @param expression the search expression or null for wildcard
      * @param offet zero-based index of the first object to return
      * @param max_count maximum number of objects to return
      * @param total_matches sets it to the actual number of objects that satisfy
-     *                      the given search expression. If it is not possible
-     *                      to compute this value (in a timely mannger), it is
-     *                      set to '0'.
-     * @param cancellable optional cancellable for this operation
+     * @param cancellable optional cancellable for this operation.
      *
-     * return A list of media objects.
+     * @return yaddayadda
      */
     public abstract async MediaObjects? search (SearchExpression? expression,
                                                 uint              offset,
@@ -65,7 +62,7 @@ public interface Rygel.SearchableContainer : MediaContainer {
      *                      set to '0'.
      * @param cancellable optional cancellable for this operation
      *
-     * return A list of media objects.
+     * @return A list of media objects.
      */
     public async MediaObjects? simple_search (SearchExpression? expression,
                                               uint              offset,
@@ -146,7 +143,7 @@ public interface Rygel.SearchableContainer : MediaContainer {
      * @param cancellable optional cancellable for this operation
      * @param callback function to call when result is ready
      *
-     * return the found media object.
+     * @return the found media object.
      */
     public async MediaObject? find_object (string       id,
                                            Cancellable? cancellable)
diff --git a/src/librygel-core/rygel-writable-container.vala b/src/librygel-core/rygel-writable-container.vala
index bc9097a..0656ed2 100644
--- a/src/librygel-core/rygel-writable-container.vala
+++ b/src/librygel-core/rygel-writable-container.vala
@@ -62,7 +62,7 @@ public interface Rygel.WritableContainer : MediaContainer {
      * @param item The item to add to this container
      * @param cancellable optional cancellable for this operation
      *
-     * return nothing.
+     * @return nothing.
      *
      */
     public async abstract void add_item (MediaItem    item,
@@ -77,7 +77,7 @@ public interface Rygel.WritableContainer : MediaContainer {
      * @param item The ID of the item to remove from this container
      * @param cancellable optional cancellable for this operation
      *
-     * return nothing.
+     * @return nothing.
      *
      */
     public async abstract void remove_item (string id, Cancellable? cancellable)



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