From a91031b24d177ca6a61f295b44cf03dd694bf9ef Mon Sep 17 00:00:00 2001 From: Rico Tzschichholz Date: Sun, 9 Apr 2023 13:29:26 +0200 Subject: valadoc/tests: Add girwriter test --- configure.ac | 1 + valadoc/tests/Makefile.am | 4 + valadoc/tests/girwriter/GirTest-1.0.gir-expected | 218 +++++++++++++++++++++++ valadoc/tests/girwriter/Makefile.am | 35 ++++ valadoc/tests/girwriter/girtest.vala | 106 +++++++++++ 5 files changed, 364 insertions(+) create mode 100644 valadoc/tests/girwriter/GirTest-1.0.gir-expected create mode 100644 valadoc/tests/girwriter/Makefile.am create mode 100644 valadoc/tests/girwriter/girtest.vala diff --git a/configure.ac b/configure.ac index c9df433f8..e2e31ea37 100644 --- a/configure.ac +++ b/configure.ac @@ -292,6 +292,7 @@ AC_CONFIG_FILES([Makefile valadoc/doclets/gtkdoc/Makefile valadoc/icons/Makefile valadoc/tests/Makefile + valadoc/tests/girwriter/Makefile ]) AC_OUTPUT diff --git a/valadoc/tests/Makefile.am b/valadoc/tests/Makefile.am index b6e6104c9..559642a39 100644 --- a/valadoc/tests/Makefile.am +++ b/valadoc/tests/Makefile.am @@ -2,6 +2,10 @@ include $(top_srcdir)/Makefile.common NULL = +SUBDIRS = \ + girwriter \ + $(NULL) + LOG_COMPILER = $(abs_top_srcdir)/build-aux/testrunner.sh AM_TESTS_ENVIRONMENT = \ export UPDATE_EXPECTED=$(UPDATE_EXPECTED); \ diff --git a/valadoc/tests/girwriter/GirTest-1.0.gir-expected b/valadoc/tests/girwriter/GirTest-1.0.gir-expected new file mode 100644 index 000000000..4a3620d55 --- /dev/null +++ b/valadoc/tests/girwriter/GirTest-1.0.gir-expected @@ -0,0 +1,218 @@ + + + + + + + <para>An example comment for an example enum.</para> + + + + <para>An example comment for an example errordomain.</para> + + + + <para>An example comment for an example class.</para> + + + + + + + + <para>An example comment for an example class constructor.</para> + + + + + + <para>An example comment for an example parameter. </para> + + + + + + <para>An example comment for an example class method.</para> + + <para>An example comment for an example return value. </para> + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + <para>An example comment for an example property.</para> + + + + + + + + + + + + + + + + + + + + + + + + + + + <para>An example comment for an example signal.</para> + + + + + + <para>An example comment for an example parameter. </para> + + + + + + + + + + + + + <para>An example comment for an example interface.</para> + + + <para>An example comment for an example interface method.</para> + + <para>An example comment for an example return value. </para> + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + <para>An example comment for an example interface method.</para> + + <para>An example comment for an example return value. </para> + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + + + + + + + + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + + + <para>An example comment for an example struct.</para> + + <para>An example comment for an example field.</para> + + + + <para>An example comment for an example struct constructor.</para> + + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + <para>An example comment for an example struct method.</para> + + <para>An example comment for an example return value. </para> + + + + + + + + <para>An example comment for an example parameter. </para> + + + + + + + <para>An example comment for an example delegate.</para> + + <para>An example comment for an example return value. </para> + + + + + <para>An example comment for an example parameter. </para> + + + + + + + + + <para>An example comment for an example constant.</para> + + + + <para>An example comment for an example function.</para> + + + + + + diff --git a/valadoc/tests/girwriter/Makefile.am b/valadoc/tests/girwriter/Makefile.am new file mode 100644 index 000000000..f4f4a11cc --- /dev/null +++ b/valadoc/tests/girwriter/Makefile.am @@ -0,0 +1,35 @@ +NULL = +GIRDIR = $$($(PKG_CONFIG) gobject-introspection-1.0 --variable=girdir) + +check-girwriter: $(top_builddir)/valadoc/valadoc + rm -rf $(builddir)/girtest; + G_DEBUG=fatal-warnings $(top_builddir)/valadoc/valadoc \ + --vapidir $(top_srcdir)/vapi \ + --directory $(builddir)/girtest \ + --doclet=$(top_builddir)/valadoc/doclets/html/.libs \ + --pkg gio-2.0 \ + --gir GirTest-1.0.gir \ + $(srcdir)/girtest.vala; \ + tail -n +3 GirTest-1.0.gir | diff -wu $(srcdir)/GirTest-1.0.gir-expected - || exit 1; +if HAVE_G_IR_COMPILER + $(G_IR_COMPILER) -o GirTest-1.0.typelib GirTest-1.0.gir; +endif +if HAVE_JING + $(JING) -c -e UTF-8 $(GIRDIR)/gir-1.2.rnc GirTest-1.0.gir || echo "Ignoring above error(s)"; +endif + rm -f GirTest-1.0.gir GirTest-1.0.typelib girtest.vapi girtest.c; + rm -rf $(builddir)/girtest; + +check: check-girwriter + +EXTRA_DIST = \ + girtest.vala \ + GirTest-1.0.gir-expected \ + $(NULL) + +CLEANFILES = \ + girtest.c \ + girtest.vapi \ + GirTest-1.0.gir \ + GirTest-1.0.typelib \ + $(NULL) diff --git a/valadoc/tests/girwriter/girtest.vala b/valadoc/tests/girwriter/girtest.vala new file mode 100644 index 000000000..a294b6d82 --- /dev/null +++ b/valadoc/tests/girwriter/girtest.vala @@ -0,0 +1,106 @@ +[CCode (gir_namespace = "GirTest", gir_version = "1.0")] +namespace GirTest { + /** + * An example comment for an example constant. + */ + public const int CONSTANT = 42; + + /** + * An example comment for an example function. + */ + public static void function () { + } + + /** + * An example comment for an example struct. + */ + public struct StructTest { + /** + * An example comment for an example field. + */ + public int field; + /** + * An example comment for an example struct constructor. + * + * @param param An example comment for an example parameter. + */ + public StructTest (int param) { + } + /** + * An example comment for an example struct method. + * + * @param param An example comment for an example parameter. + * @return An example comment for an example return value. + */ + public bool method (int param) { + return true; + } + } + + /** + * An example comment for an example enum. + */ + public enum EnumTest { + VALUE1 + } + + /** + * An example comment for an example errordomain. + */ + public errordomain ErrorTest { + VALUE1 + } + + /** + * An example comment for an example delegate. + * + * @param param An example comment for an example parameter. + * @return An example comment for an example return value. + */ + public delegate bool DelegateTest (int param); + + /** + * An example comment for an example interface. + */ + public interface InterfaceTest : Object { + /** + * An example comment for an example interface method. + * + * @param param An example comment for an example parameter. + * @return An example comment for an example return value. + */ + public abstract bool method (int param); + } + + /** + * An example comment for an example class. + */ + public class ObjectTest : Object { + /** + * An example comment for an example property. + */ + public int property { get; construct set; } + /** + * An example comment for an example signal. + * + * @param param An example comment for an example parameter. + */ + public signal void some_signal (int param); + /** + * An example comment for an example class constructor. + * + * @param param An example comment for an example parameter. + */ + public ObjectTest (int param) { + } + /** + * An example comment for an example class method. + * + * @param param An example comment for an example parameter. + * @return An example comment for an example return value. + */ + public bool method (int param) { + return true; + } + } +} -- cgit v1.2.1