[nautilus-actions: 10/19] Add documentation for public functions



commit 5653cd5b6788f7dce7e9ae84a740ce25bd9ebd8a
Author: Pierre Wieser <pwieser trychlos org>
Date:   Tue Jun 9 21:41:02 2009 +0200

    Add documentation for public functions
---
 ChangeLog                      |    1 +
 src/common/nact-iio-provider.c |    7 +++++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 8c2fc7b..87d6a23 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -12,6 +12,7 @@
 	(nact_action_profile_load): Remove function and cleanup the code.
 
 	* src/common/nact-gconf.c:
+	* src/common/nact-iio-provider.c:
 	Cleanup the code, adding documentation to public functions.
 
 	* src/common/nact-object.c:
diff --git a/src/common/nact-iio-provider.c b/src/common/nact-iio-provider.c
index 47ae424..048e4f2 100644
--- a/src/common/nact-iio-provider.c
+++ b/src/common/nact-iio-provider.c
@@ -117,9 +117,12 @@ interface_base_finalize( NactIIOProviderInterface *klass )
 }
 
 /**
- * Load the defined actions.
+ * Loads the actions defined in the system.
  *
- * Return a GSList of NactAction objects.
+ * @object: the pivot object which owns the list of registered
+ * interface providers.
+ *
+ * Returns a GSList of newly allocated NactAction objects.
  */
 GSList *
 nact_iio_provider_load_actions( const GObject *object )



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