Gio::UnixFDList: Add params and returns in create() method docs.

	* gio/src/unixfdlist.hg (create): Add @param and @return to the method
	docs for clarity.

2 files changed, 11 insertions, 2 deletions

diff --git a/ChangeLog b/ChangeLog
index 5785086a..e8c60b9d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2010-07-26  José Alburquerque  <jaalburqu@svn.gnome.org>
 
+	Gio::UnixFDList: Add params and returns in create() method docs.
+
+	* gio/src/unixfdlist.hg (create): Add @param and @return to the method
+	docs for clarity.
+
+2010-07-26  José Alburquerque  <jaalburqu@svn.gnome.org>
+
 	Add Gio::UnixFDList.
 
 	* gio/src/unixfdlist.ccg:
diff --git a/gio/src/unixfdlist.hg b/gio/src/unixfdlist.hg
index 3b16770c..9a673ef8 100644
--- a/gio/src/unixfdlist.hg
+++ b/gio/src/unixfdlist.hg
@@ -62,6 +62,8 @@ public:
    * longer be used by the caller. The array itself is owned by the caller.
    *
    * Each file descriptor in the array should be set to close-on-exec.
+   * @param fds The list of file descriptors to use for creation.
+   * @return A new UnixFDList.
    */
   _WRAP_CREATE(const Glib::ArrayHandle<int>& fds)
 
@@ -76,7 +78,7 @@ public:
    * After this call, the descriptors remain the property of the list. The
    * caller must not close them. The array is valid only until list is changed
    * in any way.
-   * @return the list of file descriptors.
+   * @return The list of file descriptors.
    */
   Glib::ArrayHandle<int> peek_fds() const;
 
@@ -88,7 +90,7 @@ public:
    *
    * The caller is responsible for closing all of the file descriptors. The
    * file descriptors in the array are set to close-on-exec.
-   * @return the list of file descriptors.
+   * @return The list of file descriptors.
    */
   Glib::ArrayHandle<int> steal_fds();