[Groonga-commit] groonga/groonga-gobject at 3dd9acf [master] Support GTK-Doc

Back to archive index

Kouhei Sutou null+****@clear*****
Sun Dec 1 18:56:00 JST 2013


Kouhei Sutou	2013-12-01 18:56:00 +0900 (Sun, 01 Dec 2013)

  New Revision: 3dd9acf4ed26dbe174f42e7f9d9f0498c1f17879
  https://github.com/groonga/groonga-gobject/commit/3dd9acf4ed26dbe174f42e7f9d9f0498c1f17879

  Message:
    Support GTK-Doc

  Added files:
    doc/reference/groonga-gobject-docs.sgml
    doc/reference/groonga-gobject-overrides.txt
    doc/reference/version.xml.in
  Copied files:
    doc/Makefile.am
      (from autogen.sh)
    doc/reference/Makefile.am
      (from Makefile.am)
  Modified files:
    .gitignore
    Makefile.am
    autogen.sh
    configure.ac
    groonga-gobject/ggrn-context.h

  Modified: .gitignore (+18 -0)
===================================================================
--- .gitignore    2013-12-01 17:47:25 +0900 (1de419e)
+++ .gitignore    2013-12-01 18:56:00 +0900 (a0a57a0)
@@ -19,3 +19,21 @@ Makefile
 /groonga-gobject.pc
 /libtool
 /stamp-h1
+/doc/reference/html/
+/doc/reference/tmpl/
+/doc/reference/xml/
+/doc/reference/version.xml
+/doc/reference/*.stamp
+/doc/reference/gtk-doc.make
+/doc/reference/groonga-gobject-decl-list.txt
+/doc/reference/groonga-gobject-decl.txt
+/doc/reference/groonga-gobject-sections.txt
+/doc/reference/groonga-gobject-undeclared.txt
+/doc/reference/groonga-gobject-undocumented.txt
+/doc/reference/groonga-gobject-unused.txt
+/doc/reference/groonga-gobject.args
+/doc/reference/groonga-gobject.hierarchy
+/doc/reference/groonga-gobject.interfaces
+/doc/reference/groonga-gobject.prerequisites
+/doc/reference/groonga-gobject.signals
+/doc/reference/groonga-gobject.types

  Modified: Makefile.am (+2 -1)
===================================================================
--- Makefile.am    2013-12-01 17:47:25 +0900 (6566fde)
+++ Makefile.am    2013-12-01 18:56:00 +0900 (d7a4881)
@@ -19,4 +19,5 @@ DISTCHECK_CONFIGURE_FLAGS =			\
 	--enable-introspection
 
 SUBDIRS =					\
-	groonga-gobject
+	groonga-gobject				\
+	doc

  Modified: autogen.sh (+1 -0)
===================================================================
--- autogen.sh    2013-12-01 17:47:25 +0900 (aea70c4)
+++ autogen.sh    2013-12-01 18:56:00 +0900 (82ae23b)
@@ -18,4 +18,5 @@
 set -u
 set -e
 
+gtkdocize --copy --docdir doc/reference
 autoreconf --install

  Modified: configure.ac (+3 -0)
===================================================================
--- configure.ac    2013-12-01 17:47:25 +0900 (2a6ae7d)
+++ configure.ac    2013-12-01 18:56:00 +0900 (a0337d2)
@@ -95,6 +95,9 @@ AC_CONFIG_FILES([
   groonga-gobject.pc
   Makefile
   groonga-gobject/Makefile
+  doc/Makefile
+  doc/reference/Makefile
+  doc/reference/version.xml
 ])
 
 AC_OUTPUT

  Copied: doc/Makefile.am (+2 -6) 93%
  Mode: 100755 -> 100644
===================================================================
--- autogen.sh    2013-12-01 17:47:25 +0900 (aea70c4)
+++ doc/Makefile.am    2013-12-01 18:56:00 +0900 (f4df283)
@@ -1,5 +1,3 @@
-#!/bin/sh
-#
 # Copyright (C) 2013  Kouhei Sutou <kou �� clear-code.com>
 #
 # This library is free software: you can redistribute it and/or modify
@@ -15,7 +13,5 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-set -u
-set -e
-
-autoreconf --install
+SUBDIRS =					\
+	reference

  Copied: doc/reference/Makefile.am (+33 -5) 50%
===================================================================
--- Makefile.am    2013-12-01 17:47:25 +0900 (6566fde)
+++ doc/reference/Makefile.am    2013-12-01 18:56:00 +0900 (6cfab0a)
@@ -13,10 +13,38 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
+DOC_MODULE = groonga-gobject
 
-DISTCHECK_CONFIGURE_FLAGS =			\
-	--enable-introspection
+DOC_MAIN_SGML_FILE = groonga-gobject-docs.sgml
 
-SUBDIRS =					\
-	groonga-gobject
+DOC_SOURCE_DIR =				\
+	$(top_srcdir)/groonga-gobject
+
+SCAN_OPTIONS =						\
+	--deprecated-guards="GGRN_DISABLE_DEPRECATED"
+
+MKDB_OPTIONS =						\
+	--name-space=ggrn
+
+HFILE_GLOB =					\
+	$(top_srcdir)/groonga-gobject/*.h
+
+CFILE_GLOB =					\
+	$(top_srcdir)/groonga-gobject/*.c
+
+AM_CPPFLAGS =					\
+	-I$(top_srcdir)				\
+	-I$(top_srcdir)/groonga-gobject		\
+	$(GLIB_CFLAGS)				\
+	$(GROONGA_CFLAGS)
+
+GTKDOC_LIBS =							\
+	$(top_builddir)/groonga-gobject/libgroonga-gobject.la	\
+	$(GLIB_LIBS)						\
+	$(GROONGA_LIBS)
+
+include $(srcdir)/gtk-doc.make
+
+CLEANFILES +=					\
+	$(DOC_MODULE)-sections.txt		\
+	$(DOC_MODULE).types

  Added: doc/reference/groonga-gobject-docs.sgml (+32 -0) 100644
===================================================================
--- /dev/null
+++ doc/reference/groonga-gobject-docs.sgml    2013-12-01 18:56:00 +0900 (c3cb05d)
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book xmlns:xi="http://www.w3.org/2003/XInclude" id="index" lang="en">
+  <bookinfo>
+    <title>Groonga GObject Reference Manual</title>
+    <releaseinfo>for Groonga GObject &version;</releaseinfo>
+  </bookinfo>
+
+  <part id="start">
+    <title>Getting start</title>
+  </part>
+
+  <part id="reference">
+    <title>Reference</title>
+    <chapter id="libgroonga-gobject">
+      <title>libgroonga-gobject</title>
+      <xi:include href="xml/ggrn-context.xml"/>
+    </chapter>
+  </part>
+
+  <index id="index-all">
+    <title>Index of all symbols</title>
+  </index>
+  <index id="index-deprecated" role="deprecated">
+    <title>Index of deprecated symbols</title>
+  </index>
+  <index id="index-1-0-0" role="1.0.0">
+    <title>Index of new symbols in 1.0.0</title>
+  </index>
+</book>

  Added: doc/reference/groonga-gobject-overrides.txt (+0 -0) 100644
===================================================================
--- /dev/null
+++ doc/reference/groonga-gobject-overrides.txt    2013-12-01 18:56:00 +0900 (e69de29)

  Added: doc/reference/version.xml.in (+1 -0) 100644
===================================================================
--- /dev/null
+++ doc/reference/version.xml.in    2013-12-01 18:56:00 +0900 (d78bda9)
@@ -0,0 +1 @@
+ �� VERSION@

  Modified: groonga-gobject/ggrn-context.h (+7 -1)
===================================================================
--- groonga-gobject/ggrn-context.h    2013-12-01 17:47:25 +0900 (08c8078)
+++ groonga-gobject/ggrn-context.h    2013-12-01 18:56:00 +0900 (d0d585d)
@@ -39,9 +39,15 @@ G_BEGIN_DECLS
 typedef struct _GGrnContext         GGrnContext;
 typedef struct _GGrnContextClass    GGrnContextClass;
 
+/**
+ * GGrnContext:
+ *
+ * A GGrnContext is the operation context for a database.
+ */
 struct _GGrnContext
 {
-    GObject object;
+    /*< private >*/
+    GObject parent_instance;
 };
 
 struct _GGrnContextClass
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index