gtk-doc r606 - in trunk: . tests tests/annotations tests/annotations/docs tests/annotations/src

[stefkost svn gnome org]

Author: stefkost
Date: Sat Oct 11 16:29:03 2008
New Revision: 606
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=606&view=rev

Log:
	* configure.in:
	* tests/Makefile.am:
	* tests/annotations.sh:
	* tests/annotations/Makefile.am:
	* tests/annotations/docs/Makefile.am:
	* tests/annotations/docs/tester-docs.xml:
	* tests/annotations/docs/tester-sections.txt:
	* tests/annotations/src/Makefile.am:
	* tests/annotations/src/tester.c:
	* tests/annotations/src/tester.h:
	  Add testcases for gir annotation.



Added:
   trunk/tests/annotations/
   trunk/tests/annotations.sh   (contents, props changed)
   trunk/tests/annotations/Makefile.am   (contents, props changed)
   trunk/tests/annotations/docs/
   trunk/tests/annotations/docs/Makefile.am   (contents, props changed)
   trunk/tests/annotations/docs/tester-docs.xml
   trunk/tests/annotations/docs/tester-sections.txt   (contents, props changed)
   trunk/tests/annotations/src/
   trunk/tests/annotations/src/Makefile.am   (contents, props changed)
   trunk/tests/annotations/src/tester.c   (contents, props changed)
   trunk/tests/annotations/src/tester.h   (contents, props changed)
Modified:
   trunk/ChangeLog
   trunk/configure.in
   trunk/tests/Makefile.am

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Sat Oct 11 16:29:03 2008
@@ -162,6 +162,9 @@
 tests/bugs/Makefile
 tests/bugs/src/Makefile
 tests/bugs/docs/Makefile
+tests/annotations/Makefile
+tests/annotations/src/Makefile
+tests/annotations/docs/Makefile
 ])
 
 dnl run chmod on these after parsing them.

Modified: trunk/tests/Makefile.am
==============================================================================
--- trunk/tests/Makefile.am	(original)
+++ trunk/tests/Makefile.am	Sat Oct 11 16:29:03 2008
@@ -1,10 +1,10 @@
 ## Process this file with automake to produce Makefile.in
 
-SUBDIRS = gobject bugs .
+SUBDIRS = gobject bugs annotations .
 
 if BUILD_TESTS
 
-TESTS = gobject.sh bugs.sh
+TESTS = gobject.sh bugs.sh annotations.sh
 TESTS_ENVIRONMENT = PATH=$(srcdir):$(PATH)
 
 endif

Added: trunk/tests/annotations.sh
==============================================================================
--- (empty file)
+++ trunk/tests/annotations.sh	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+gtkdoctest.sh annotations
+

Added: trunk/tests/annotations/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/Makefile.am	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,10 @@
+## Process this file with automake to produce Makefile.in
+
+SUBDIRS = . src docs
+
+if BUILD_TESTS
+
+check-local: clean
+
+endif
+

Added: trunk/tests/annotations/docs/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/docs/Makefile.am	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,78 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=tester
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# 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.
+DOC_SOURCE_DIR=$(top_srcdir)/tests/annotations/src
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=2>&1 | tee gtkdoc-scangobj.log
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=--deprecated-guards="GTKDOC_TESTER_DISABLE_DEPRECATED" \
+  --ignore-decorators="GLIB_VAR" \
+  2>&1 | tee gtkdoc-scan.log
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode --name-space=bug 2>&1 | tee gtkdoc-mkdb.log
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=2>&1 | tee gtkdoc-mktmpl.log
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=2>&1 | tee ../gtkdoc-mkhtml.log
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# --html-dir=$(HTML_DIR)
+FIXXREF_OPTIONS=--extra-dir=$(glib_prefix)/share/gtk-doc/html 2>&1 | tee gtkdoc-fixxref.log
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+HFILE_GLOB=$(top_srcdir)/tests/annotations/src/*.h
+CFILE_GLOB=$(top_srcdir)/tests/annotations/src/*.c
+
+# Header files to ignore when scanning.
+IGNORE_HFILES=config.h
+
+# Images to copy into HTML directory.
+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.
+GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/tests/annotations/src $(TEST_DEPS_CFLAGS)
+GTKDOC_LIBS = $(TEST_DEPS_LIBS) $(top_builddir)/tests/annotations/src/libtester.la
+
+# include generic part
+include $(top_srcdir)/tests/gtk-doc.notmpl.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+DISTCLEANFILES = \
+	gtkdoc-scan.log \
+	gtkdoc-scangobj.log \
+	gtkdoc-mktmpl.log \
+	gtkdoc-mkdb.log \
+	gtkdoc-mkhtml.log \
+	gtkdoc-fixxref.log
+

Added: trunk/tests/annotations/docs/tester-docs.xml
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/docs/tester-docs.xml	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
+  <bookinfo>
+    <title>tester Reference Manual</title>
+    <releaseinfo>
+      for tester [VERSION]
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/tester/index.html";>http://[SERVER]/tester/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>Tests</title>
+    <xi:include href="xml/tester.xml"/>
+  </chapter>
+
+  <index id="api-index">
+    <title>API Index</title>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+  </index>
+  <!--index id="api-index-0-9" role="0.9">
+    <title>Index of new API in 0.9</title>
+  </index-->
+
+</book>

Added: trunk/tests/annotations/docs/tester-sections.txt
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/docs/tester-sections.txt	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,9 @@
+<SECTION>
+<FILE>tester</FILE>
+<TITLE>GtkdocTester</TITLE>
+annotation_array_length
+annotation_nullable
+<SUBSECTION Standard>
+<SUBSECTION Private>
+</SECTION>
+

Added: trunk/tests/annotations/src/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/src/Makefile.am	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,13 @@
+## Process this file with automake to produce Makefile.in
+
+if BUILD_TESTS
+
+noinst_LTLIBRARIES = libtester.la
+
+libtester_la_SOURCES = tester.c tester.h
+#libtester_la_LIBADD = $(TEST_DEPS_LIBS)
+
+INCLUDES = $(TEST_DEPS_CFLAGS)
+
+endif
+

Added: trunk/tests/annotations/src/tester.c
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/src/tester.c	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,41 @@
+/**
+ * SECTION:tester
+ * @short_description: module for gtk-doc unit test
+ *
+ * This file contains non-sense code for the sole purpose of testing the docs.
+ */
+
+#include <glib.h>
+#include <glib-object.h>
+
+#include "tester.h"
+
+/**
+ * annotation_array_length:
+ * @store: a #GtkListStore
+ * @n_columns: number of columns
+ * @types: [array,length=n_columns]: list of types
+ *
+ * Document parameter relation for array length.
+ */
+void
+annotation_array_length (GObject *list,
+                         gint          n_columns,
+                         GType        *types)
+{
+}
+
+
+/**
+ * annotation_nullable:
+ * @uri: a uri
+ * @label: [allow-none]: an optional string
+ *
+ * Document optional parameters.
+ */
+void
+annotation_nullable (const gchar *uri,
+                     const gchar *label)
+{
+}
+

Added: trunk/tests/annotations/src/tester.h
==============================================================================
--- (empty file)
+++ trunk/tests/annotations/src/tester.h	Sat Oct 11 16:29:03 2008
@@ -0,0 +1,12 @@
+#ifndef GTKDOC_TESTER_H
+#define GTKDOC_TESTER_H
+
+#include <glib.h>
+#include <glib-object.h>
+
+extern void annotation_array_length (GObject *list, gint n_columns, GType *types);
+
+extern void annotation_nullable (const gchar *uri, const gchar *label);
+
+#endif // GTKDOC_TESTER_H
+