diff options
author | Gilles Dartiguelongue <gdartigu@svn.gnome.org> | 2008-09-03 23:20:30 +0000 |
---|---|---|
committer | Gilles Dartiguelongue <gdartigu@src.gnome.org> | 2008-09-03 23:20:30 +0000 |
commit | 5f460bab23c75a7ad19165f9d1be40edda8f309b (patch) | |
tree | b1fc101adbf75e8ef78cf04d3130a9f5c3bf30a8 | |
parent | 88167f4cd4795de5fdd85dcec9e661e8f8cf1436 (diff) | |
download | nautilus-5f460bab23c75a7ad19165f9d1be40edda8f309b.tar.gz |
include some documentation, bug #396929.
2008-09-04 Gilles Dartiguelongue <gdartigu@svn.gnome.org>
include some documentation, bug #396929.
svn path=/trunk/; revision=14581
-rw-r--r-- | ChangeLog | 14 | ||||
-rw-r--r-- | configure.in | 4 | ||||
-rw-r--r-- | docs/reference/libnautilus-extension/Makefile.am | 34 | ||||
-rw-r--r-- | libnautilus-extension/nautilus-column.c | 11 | ||||
-rw-r--r-- | libnautilus-extension/nautilus-menu-item.c | 24 | ||||
-rw-r--r-- | libnautilus-extension/nautilus-property-page.c | 12 | ||||
-rw-r--r-- | libnautilus-extension/nautilus-property-page.h | 4 |
7 files changed, 86 insertions, 17 deletions
@@ -1,3 +1,17 @@ +2008-09-04 Gilles Dartiguelongue <gdartigu@svn.gnome.org> + + * configure.in: + * docs/reference/Makefile.am: + * docs/reference/libnautilus-extension/Makefile.am: + * docs/reference/libnautilus-extension/libnautilus-extension-docs.x + ml: + * libnautilus-extension/nautilus-column.c: + * libnautilus-extension/nautilus-menu-item.c: + * libnautilus-extension/nautilus-property-page.c: + (nautilus_property_page_get_type): + * libnautilus-extension/nautilus-property-page.h: + include some documentation, bug #396929. + 2008-09-03 Christian Neumair <cneumair@gnome.org> * libnautilus-private/nautilus-file-operations.c (create_job): diff --git a/configure.in b/configure.in index 9c7171fb3..a613f0168 100644 --- a/configure.in +++ b/configure.in @@ -35,7 +35,7 @@ dnl =========================================================================== AC_CONFIG_SRCDIR(src) AC_CONFIG_HEADERS(config.h) -AM_INIT_AUTOMAKE +AM_INIT_AUTOMAKE([1.9 tar-ustar]) AM_MAINTAINER_MODE AC_SUBST([ACLOCAL_AMFLAGS], ["\${ACLOCAL_FLAGS}"]) @@ -115,7 +115,7 @@ IT_PROG_INTLTOOL([0.35.0]) dnl ========================================================================== -GTK_DOC_CHECK +GTK_DOC_CHECK([1.4]) dnl ========================================================================== diff --git a/docs/reference/libnautilus-extension/Makefile.am b/docs/reference/libnautilus-extension/Makefile.am index 8e2b48ad1..1011a6af4 100644 --- a/docs/reference/libnautilus-extension/Makefile.am +++ b/docs/reference/libnautilus-extension/Makefile.am @@ -6,7 +6,7 @@ AUTOMAKE_OPTIONS = 1.6 # The name of the module, e.g. 'glib'. DOC_MODULE=libnautilus-extension -# The top-level SGML file. You can change this if you want to. +# The top-level SGML file. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml # The directory containing the source code. Relative to $(srcdir). @@ -23,7 +23,6 @@ SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" # Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml MKDB_OPTIONS=--sgml-mode --output-format=xml # Extra options to supply to gtkdoc-mktmpl @@ -34,18 +33,20 @@ MKTMPL_OPTIONS= # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html FIXXREF_OPTIONS= +# Used for dependencies. The docs will be rebuilt if any of these change. HFILE_GLOB=$(top_srcdir)/libnautilus-extension/*.h CFILE_GLOB=$(top_srcdir)/libnautilus-extension/*.c -IGNORE_HFILES= \ +# Header files to ignore when scanning. +IGNORE_HFILES = \ + config.h \ + nautilus-extension-i18n.h \ $(NULL) -EXTRA_HFILES= \ - $(NULL) - -HTML_IMAGES= +# Images to copy into HTML directory +HTML_IMAGES = -content_files= \ +content_files = \ version.xml \ $(NULL) @@ -53,17 +54,26 @@ content_files= \ # These files must be listed here *and* in content_files # e.g. expand_content_files=running.sgml expand_content_files= \ - $(NULL) + $(NULL) # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. # Only needed if you are using gtkdoc-scangobj to dynamically query widget # signals and properties. # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = \ + $(GTK_DEBUG_FLAGS) \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/libnautilus-extension \ + -I$(top_builddir) \ + -I$(top_builddir)/libnautilus-extension \ + $(LIBNAUTILUS_EXTENSION_CFLAGS) \ + $(NULL) -INCLUDES=-I$(top_srcdir) $(CORE_CFLAGS) -GTKDOC_LIBS= -L$(top_builddir) $(CORE_LIBS) \ - $(top_builddir)/libnautilus-extension/libnautilus-extension.la \ +GTKDOC_LIBS = \ + $(top_builddir)/libnautilus-extension/libnautilus-extension.la \ + $(LIBNAUTILUS_EXTENSION_LIBS) \ $(NULL) # This includes the standard gtk-doc make rules, copied by gtkdocize. 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; |