Merge lp:~ricotz/bamf/annotation-fixes into lp:bamf/0.4

[Rico Tzschichholz]

libbamf: gir-annotion fixes and make gi-scanner verbose

libbamf: gir-annotion fixes and make gi-scanner verbose

[lp:~ricotz/bamf/annotation-fixes]

491. By Rico Tzschichholz on 2012-10-08

libbamf: only perform introspection on public api

[Marco Trevisan (Treviño) (3v1n0)]

Looks good, thanks!

review: Approve

=== modified file 'lib/libbamf/Makefile.am'
--- lib/libbamf/Makefile.am	2012-07-31 15:51:02 +0000
+++ lib/libbamf/Makefile.am	2012-10-08 17:07:43 +0000
@@ -113,11 +113,15 @@
 
 if HAVE_INTROSPECTION
 
-introspection_sources = $(libbamf_la_SOURCES)
+introspection_sources = \
+	$(sources_h) \
+	$(libbamf_sources) \
+	$(NULL)
 
 Bamf-0.2.gir: libbamf.la
 Bamf_0_2_gir_INCLUDES = GObject-2.0 GLib-2.0
 Bamf_0_2_gir_CFLAGS = \
+	--warn-all \
 	--c-include='libbamf/libbamf.h' \
 	$(DBUS_CFLAGS) \
 	-I$(top_srcdir)/lib \

=== modified file 'lib/libbamf/bamf-application.c'
--- lib/libbamf/bamf-application.c	2012-09-28 19:54:41 +0000
+++ lib/libbamf/bamf-application.c	2012-10-08 17:07:43 +0000
@@ -72,6 +72,12 @@
   int             show_stubs;
 };
 
+/**
+ * bamf_application_get_supported_mime_types:
+ * @application: a #BamfApplication
+ *
+ * Returns: (transfer full) (array zero-terminated=1): A string array containing the supported mime-types.
+ */
 gchar **
 bamf_application_get_supported_mime_types (BamfApplication *application)
 {
@@ -402,6 +408,12 @@
     }
 }
 
+/**
+ * bamf_application_get_focusable_child:
+ * @application: a #BamfApplication
+ *
+ * Returns: (transfer none): The focusable child for this application.
+ */
 BamfView *
 bamf_application_get_focusable_child (BamfApplication *application)
 {

=== modified file 'lib/libbamf/bamf-control.c'
--- lib/libbamf/bamf-control.c	2012-07-05 06:30:47 +0000
+++ lib/libbamf/bamf-control.c	2012-10-08 17:07:43 +0000
@@ -112,6 +112,11 @@
     }
 }
 
+/**
+ * bamf_control_get_default:
+ *
+ * Returns: (transfer none): The default #BamfControl reference.
+ */
 BamfControl *
 bamf_control_get_default (void)
 {

=== modified file 'lib/libbamf/bamf-tab-source.c'
--- lib/libbamf/bamf-tab-source.c	2012-08-21 22:02:12 +0000
+++ lib/libbamf/bamf-tab-source.c	2012-10-08 17:07:43 +0000
@@ -68,6 +68,12 @@
   return TRUE;
 }
 
+/**
+ * bamf_tab_source_get_tab_ids:
+ * @source: a #BamfTabSource
+ *
+ * Returns: (transfer none) (allow-none) (array zero-terminated=1): A string array containing the IDs of this #BamfTabSource.
+ */
 char **
 bamf_tab_source_get_tab_ids     (BamfTabSource *source)
 {
@@ -79,6 +85,13 @@
   return NULL;
 }
 
+/**
+ * bamf_tab_source_get_tab_preview:
+ * @source: a #BamfTabSource
+ * @tab_id: an ID
+ *
+ * Returns: (transfer none) (allow-none): A #GArray containing the preview for the given ID of this #BamfTabSource.
+ */
 GArray *
 bamf_tab_source_get_tab_preview (BamfTabSource *source,
                                  char *tab_id)

=== modified file 'lib/libbamf/bamf-view.c'
--- lib/libbamf/bamf-view.c	2012-10-08 11:41:04 +0000
+++ lib/libbamf/bamf-view.c	2012-10-08 17:07:43 +0000
@@ -270,7 +270,7 @@
  * bamf_view_user_visible:
  * @view: a #BamfView
  *
- * Returns a boolean useful for determining if a particular view is "user visible". User visible
+ * Returns: a boolean useful for determining if a particular view is "user visible". User visible
  * is a concept relating to whether or not a window should be shown in a launcher tasklist.
  */
 gboolean

=== modified file 'lib/libbamf/bamf-window.c'
--- lib/libbamf/bamf-window.c	2012-07-01 18:13:55 +0000
+++ lib/libbamf/bamf-window.c	2012-10-08 17:07:43 +0000
@@ -79,7 +79,7 @@
  * bamf_window_get_transient:
  * @self: a #BamfWindow
  *
- * Returns: (transfer none) (nullable): A transient for this #BamfWindow.
+ * Returns: (transfer none) (allow-none): A transient for this #BamfWindow.
  */
 
 BamfWindow * bamf_window_get_transient (BamfWindow *self)