Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a way to test GObject-Introspection GIR generation #1104

Open
codebrainz opened this issue Jun 30, 2016 · 1 comment
Open

Add a way to test GObject-Introspection GIR generation #1104

codebrainz opened this issue Jun 30, 2016 · 1 comment

Comments

@codebrainz
Copy link
Member

It would be useful to make it easier to view the effects of changes to the Doxygen comments and API code on GIR output.

I was thinking adding a rule to doc/Makefile.am something conceptually like this, but with correct g-ir-scanner arguments as mentioned in #1094 and correct automake usage:

diff --git a/doc/Makefile.am b/doc/Makefile.am
index de5caaf..717fd6d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -148,6 +148,12 @@ CLEAN_LOCAL_TARGETS += clean-gtkdoc-header-local
 clean-gtkdoc-header-local:
        -rm -rf xml/ Doxyfile-gi Doxyfile-gi.stamp geany-gtkdoc.h geany-sciwrappers-gtkdoc.h

+# for testing results of `g-ir-scanner' during development
+geany-api.gir: geany-gtkdoc.h geany-sciwrappers-gtkdoc.h
+       $(AM_V_GEN)g-ir-scanner g-ir-scanner --pkg=$(top_builddir)/geany.pc \
+               --library=geany --accept-unprefixed --namespace=Geany --nsversion=1.0 \
+               --warn-all -o $@ geany-gtkdoc.h
+
 endif

Which could be used for testing purposes like:

$ make -C doc geany-api.gir
@b4n
Copy link
Member

b4n commented Jun 30, 2016

Yes. And it would be especially useful to be able to test for regressions, probably using an expected output and checking how it changed/did not change.

b4n added a commit to b4n/geany that referenced this issue Jul 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants