[nautilus-actions] Improve interface comments



commit db169ebb3b35a5b14ba5211e89525ae50b91aca0
Author: Pierre Wieser <pwieser trychlos org>
Date:   Sat Jan 28 21:16:41 2012 +0100

    Improve interface comments

 ChangeLog                 |    3 +++
 src/api/na-iexporter.h    |    3 +++
 src/api/na-iio-provider.h |    3 +++
 3 files changed, 9 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index fa72cae..8ccab0e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2012-01-28 Pierre Wieser <pwieser trychlos org>
 
+	* src/api/na-iexporter.h:
+	* src/api/na-iio-provider.h: Improve interface comments.
+
 	* src/core/na-factory-object.c (na_factory_object_copy):
 	Only copies non-null provider and provider data items.
 
diff --git a/src/api/na-iexporter.h b/src/api/na-iexporter.h
index 68916c1..023fd74 100644
--- a/src/api/na-iexporter.h
+++ b/src/api/na-iexporter.h
@@ -428,6 +428,9 @@ typedef struct {
 	 * displayed, as a newly allocated string which will be g_free() by the
 	 * caller.
 	 *
+	 * This may be the name of the module itself, but this also may be a
+	 * special name the modules gives to this interface.
+	 *
 	 * Defaults to a NULL string.
 	 *
 	 * Since: 2.30
diff --git a/src/api/na-iio-provider.h b/src/api/na-iio-provider.h
index df48e8a..2195c6c 100644
--- a/src/api/na-iio-provider.h
+++ b/src/api/na-iio-provider.h
@@ -270,6 +270,9 @@ typedef struct {
 	 * name of the I/O provider, as a newly allocated string which will be
 	 * g_free() by the caller.
 	 *
+	 * This may be the name of the module itself, but this also may be a
+	 * special name the modules gives to this interface.
+	 *
 	 * Defaults to an empty string.
 	 *
 	 * Since: 2.30



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