include some documentation, bug #396929.

2008-09-04  Gilles Dartiguelongue  <gdartigu@svn.gnome.org>

	include some documentation, bug #396929.


svn path=/trunk/; revision=14581

4 files changed, 48 insertions, 3 deletions

diff --git a/libnautilus-extension/nautilus-column.c b/libnautilus-extension/nautilus-column.c
index a5af0c49f..efba54527 100644
--- a/libnautilus-extension/nautilus-column.c
+++ b/libnautilus-extension/nautilus-column.c
@@ -47,6 +47,17 @@ struct _NautilusColumnDetails {
 
 static GObjectClass *parent_class = NULL;
 
+/**
+ * nautilus_column_new:
+ * @name: identifier of the column
+ * @attribute: the file attribute to be displayed in the column
+ * @label: the user-visible label for the column
+ * @description: a user-visible description of the column
+ *
+ * Creates a new column
+ *
+ * Returns: a newly created #NautilusColumn
+ */
 NautilusColumn *
 nautilus_column_new (const char *name,
 		     const char *attribute,
diff --git a/libnautilus-extension/nautilus-menu-item.c b/libnautilus-extension/nautilus-menu-item.c
index c3d2dff7d..ca65cfbee 100644
--- a/libnautilus-extension/nautilus-menu-item.c
+++ b/libnautilus-extension/nautilus-menu-item.c
@@ -57,6 +57,17 @@ static guint signals[LAST_SIGNAL];
 
 static GObjectClass *parent_class = NULL;
 
+/**
+ * nautilus_menu_item_new:
+ * @name: the identifier for the menu item
+ * @label: the user-visible label of the menu item
+ * @tip: the tooltip of the menu item
+ * @icon: the name of the icon to display in the menu item
+ *
+ * Creates a new menu item that can be added to the toolbar or to a contextual menu.
+ *
+ * Returns: a newly create #NautilusMenuItem
+ */
 NautilusMenuItem *
 nautilus_menu_item_new (const char *name,
 			const char *label,
@@ -79,12 +90,25 @@ nautilus_menu_item_new (const char *name,
 	return item;
 }
 
+/**
+ * nautilus_menu_item_activate:
+ * @item: pointer to a #NautilusMenuItem
+ *
+ * emits the activate signal.
+ */
 void
 nautilus_menu_item_activate (NautilusMenuItem *item)
 {
 	g_signal_emit (item, signals[ACTIVATE], 0);
 }
 
+/**
+ * nautilus_menu_item_set_submenu:
+ * @item: pointer to a #NautilusMenuItem
+ * @menu: pointer to a #NautilusMenu to attach to the button
+ *
+ * Attachs a menu to the given #NautilusMenuItem.
+ */
 void
 nautilus_menu_item_set_submenu (NautilusMenuItem *item, NautilusMenu *menu)
 {
diff --git a/libnautilus-extension/nautilus-property-page.c b/libnautilus-extension/nautilus-property-page.c
index a774915ac..d5f1228ce 100644
--- a/libnautilus-extension/nautilus-property-page.c
+++ b/libnautilus-extension/nautilus-property-page.c
@@ -43,6 +43,16 @@ struct _NautilusPropertyPageDetails {
 
 static GObjectClass *parent_class = NULL;
 
+/**
+ * nautilus_property_page_new:
+ * @name: the identifier for the property page
+ * @label: the user-visible label of the property page
+ * @page: the property page to display
+ *
+ * Creates a new #NautilusPropertyPage from page_widget.
+ *
+ * Returns: a newly created #NautilusPropertyPage
+ */
 NautilusPropertyPage *
 nautilus_property_page_new (const char *name,
 			    GtkWidget *label,
@@ -218,7 +228,7 @@ nautilus_property_page_get_type (void)
 		
 		type = g_type_register_static 
 			(G_TYPE_OBJECT, 
-			 "NautilusPropertPage",
+			 "NautilusPropertyPage",
 			 &info, 0);
 	}
 
diff --git a/libnautilus-extension/nautilus-property-page.h b/libnautilus-extension/nautilus-property-page.h
index 944bd2390..391a109c3 100644
--- a/libnautilus-extension/nautilus-property-page.h
+++ b/libnautilus-extension/nautilus-property-page.h
@@ -34,8 +34,8 @@ G_BEGIN_DECLS
 #define NAUTILUS_TYPE_PROPERTY_PAGE            (nautilus_property_page_get_type())
 #define NAUTILUS_PROPERTY_PAGE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NAUTILUS_TYPE_PROPERTY_PAGE, NautilusPropertyPage))
 #define NAUTILUS_PROPERTY_PAGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NAUTILUS_TYPE_PROPERTY_PAGE, NautilusPropertyPageClass))
-#define NAUTILUS_PROPERTY_IS_PAGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NAUTILUS_TYPE_PROPERTY_PAGE))
-#define NAUTILUS_PROPERTY_IS_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), NAUTILUS_TYPE_PROPERTY_PAGE))
+#define NAUTILUS_IS_PROPERTY_PAGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NAUTILUS_TYPE_PROPERTY_PAGE))
+#define NAUTILUS_IS_PROPERTY_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), NAUTILUS_TYPE_PROPERTY_PAGE))
 #define NAUTILUS_PROPERTY_PAGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), NAUTILUS_TYPE_PROPERTY_PAGE, NautilusPropertyPageClass))
 
 typedef struct _NautilusPropertyPage        NautilusPropertyPage;