[gtkmm] make check: Use xmllint to check the generated .html documentation.



commit 63867e2a20b4b28d124b38b986ac626a4063f316
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Oct 25 22:28:01 2011 +0200

    make check: Use xmllint to check the generated .html documentation.
    
    * tests/test_validate_docs_xhtml.sh: Add a small script to run xmllint.
    * Makefile.am: Run this script during make check.

 ChangeLog                         |    7 +++++++
 gtk/src/gtk_docs_override.xml     |   36 ++++++++++++++++++++++++++++++++++++
 tests/Makefile.am                 |    2 ++
 tests/test_validate_docs_xhtml.sh |    7 +++++++
 4 files changed, 52 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index cfad238..96cbd32 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2011-10-25  Murray Cumming  <murrayc murrayc com>
 
+	make check: Use xmllint to check the generated .html documentation.
+
+	* tests/test_validate_docs_xhtml.sh: Add a small script to run xmllint.
+	* Makefile.am: Run this script during make check.
+
+2011-10-25  Murray Cumming  <murrayc murrayc com>
+
 	Add #includes needed with the latest glibmm.
 
 	* gdk/src/color.hg:
diff --git a/gtk/src/gtk_docs_override.xml b/gtk/src/gtk_docs_override.xml
index f59b4c2..cde2e99 100644
--- a/gtk/src/gtk_docs_override.xml
+++ b/gtk/src/gtk_docs_override.xml
@@ -461,6 +461,42 @@ Returns a #GtkTreePath referenced by @iter.
 </return>
 </function>
 
+<!-- Avoid using @ on a parameter name used in a code example,
+  because that confuses doxygen, which then gets the start and end tags out of 
+  sequence. -->
+<function name="gtk_tree_model_rows_reordered">
+<description>
+Emits the #GtkTreeModel::rows-reordered signal on @tree_model.
+
+This should be called by models when their rows have been
+reordered.
+
+</description>
+<parameters>
+<parameter name="tree_model">
+<parameter_description> a #GtkTreeModel
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> a #GtkTreePath pointing to the tree node whose children
+have been reordered
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a valid #GtkTreeIter pointing to the node whose children
+have been reordered, or %NULL if the depth of @path is 0
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> an array of integers mapping the current position of
+each child to its old position before the re-ordering,
+i.e. new_order&lt;literal&gt;[newpos] = oldpos&lt;/literal&gt;
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 
 <function name="gtk_tree_view_column_get_cell_renderers">
 <description>
diff --git a/tests/Makefile.am b/tests/Makefile.am
index ba2297e..d968381 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -31,6 +31,8 @@ check_PROGRAMS =			\
 	scrolledwindow/test		\
 	wrap_existing/test
 
+TESTS =	test_validate_docs_xhtml.sh
+
 child_widget_test_SOURCES          = child_widget/main.cc	\
                                      child_widget/testwindow.cc	\
                                      child_widget/testwindow.h
diff --git a/tests/test_validate_docs_xhtml.sh b/tests/test_validate_docs_xhtml.sh
new file mode 100755
index 0000000..56bef5a
--- /dev/null
+++ b/tests/test_validate_docs_xhtml.sh
@@ -0,0 +1,7 @@
+#/bin/sh -e
+
+for x in $(find ${builddir}/docs/reference/html/ -name "*.html")
+do
+  # echo Validating $x
+  xmllint --noout $x || exit 1
+done



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]