[libdmapsharing] Documentation work and reference counting

[W. Michael Petullo <wmpetullo src gnome org>]

commit f8e3ccd9ec4f8f060eef9ccfdbdb0029e3168822
Author: W. Michael Petullo <mike flyn org>
Date:   Thu Aug 13 21:28:59 2009 -0400

    Documentation work and reference counting
    
    Started to add gtk-doc documentation. Worked on reference counting with
    regards to DMAPRecord and DMAPDb.

 common/Makefile.am       |    1 -
 common/autogen-helper.sh |  302 ----------------------------------------------
 dmap-mdns-browser.h      |  100 +++++++++++++++
 docs/Makefile.am         |  102 ++++++++++++++++
 4 files changed, 202 insertions(+), 303 deletions(-)
---
diff --git a/dmap-mdns-browser.h b/dmap-mdns-browser.h
new file mode 100644
index 0000000..97bd001
--- /dev/null
+++ b/dmap-mdns-browser.h
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2005 Charles Schmidt <cschmidt2 emich edu>
+ * Copyright (C) 2006 William Jon McCann <mccann jhu edu>
+ * Copyright (C) 2006 INDT
+ *  Andre Moreira Magalhaes <andre magalhaes indt org br>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA*
+ */
+
+#ifndef __DMAP_MDNS_BROWSER_H__
+#define __DMAP_MDNS_BROWSER_H__
+
+#include <glib.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define TYPE_DMAP_MDNS_BROWSER         (dmap_mdns_browser_get_type ())
+#define DMAP_MDNS_BROWSER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), TYPE_DMAP_MDNS_BROWSER, DMAPMdnsBrowser))
+#define DMAP_MDNS_BROWSER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), TYPE_DMAP_MDNS_BROWSER, DMAPMdnsBrowserClass))
+#define IS_DMAP_MDNS_BROWSER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), TYPE_DMAP_MDNS_BROWSER))
+#define IS_DMAP_MDNS_BROWSER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), TYPE_DMAP_MDNS_BROWSER))
+#define DMAP_MDNS_BROWSER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), TYPE_DMAP_MDNS_BROWSER, DMAPMdnsBrowserClass))
+
+typedef struct _DMAPMdnsBrowser        DMAPMdnsBrowser;
+typedef struct _DMAPMdnsBrowserClass   DMAPMdnsBrowserClass;
+typedef struct _DMAPMdnsBrowserPrivate DMAPMdnsBrowserPrivate;
+typedef struct _DMAPMdnsBrowserService DMAPMdnsBrowserService;
+
+typedef enum
+{
+    DMAP_MDNS_BROWSER_SERVICE_TYPE_INVALID = 0,
+    DMAP_MDNS_BROWSER_SERVICE_TYPE_DAAP,
+    DMAP_MDNS_BROWSER_SERVICE_TYPE_DPAP,
+    DMAP_MDNS_BROWSER_SERVICE_TYPE_LAST = DMAP_MDNS_BROWSER_SERVICE_TYPE_DPAP
+} DMAPMdnsBrowserServiceType;
+
+typedef enum
+{
+    DMAP_MDNS_BROWSER_ERROR_NOT_RUNNING = 0,
+    DMAP_MDNS_BROWSER_ERROR_FAILED,
+} DMAPMdnsBrowserError;
+
+struct _DMAPMdnsBrowserService
+{
+    gchar *service_name;
+    gchar *name;
+    gchar *host;
+    guint port;
+    gboolean password_protected;
+};
+
+struct _DMAPMdnsBrowserClass
+{
+    GObjectClass parent_class;
+
+    void (* service_added)    (DMAPMdnsBrowser *browser,
+                               DMAPMdnsBrowserService *service);
+    void (* service_removed ) (DMAPMdnsBrowser *browser,
+                               DMAPMdnsBrowserService *service);
+};
+
+struct _DMAPMdnsBrowser
+{
+    GObject object;
+
+    DMAPMdnsBrowserPrivate *priv;
+};
+
+#define DMAP_MDNS_BROWSER_ERROR dmap_mdns_browser_error_quark ()
+
+GQuark                     dmap_mdns_browser_error_quark      (void);
+
+GType                      dmap_mdns_browser_get_type         (void);
+
+DMAPMdnsBrowser           *dmap_mdns_browser_new              (DMAPMdnsBrowserServiceType type);
+
+gboolean                   dmap_mdns_browser_start            (DMAPMdnsBrowser *browser,
+                                                               GError **error);
+gboolean                   dmap_mdns_browser_stop             (DMAPMdnsBrowser *browser,
+                                                               GError **error);
+
+G_CONST_RETURN GSList     *dmap_mdns_browser_get_services     (DMAPMdnsBrowser *browser);
+DMAPMdnsBrowserServiceType dmap_mdns_browser_get_service_type (DMAPMdnsBrowser *browser);
+
+G_END_DECLS
+
+#endif
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..409b89c
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,102 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# 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
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# 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.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc)
+#TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk