diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-05-03 16:11:42 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:58 +0200 |
| commit | 91dde49e9aef3991dbb159507cb03b73ba507818 (patch) | |
| tree | 4bd2b8de101516534399bac20c05c6d5d8559e25 /odk/CustomTarget_doxygen.mk | |
| parent | 363a37b6e377f00e5b8c4f869d6e587394c36258 (diff) | |
odk: add DevGuide wiki links to doxygen documentation
Unsurprisingly doxygen does not support reading a idl_chapter_refs.txt
file like autodoc does. And it looks like doxygen tag files can not
be used to do this, as they link only in the "other" direction.
But with a bit of hackery we can generate a "dummy" IDL input file, with
emtpy definitions for those types that have DevGuide links.
Doxygen will nicely combine documentation from multiple definitions of a
type, and fortunately does only put in references to the first file that
defines a type, so hopefully adding the generated file as the last input
file is suffficient to make things work nicely.
The generated file is committed to git because there is a bit of a
problem with finding out what sort of entity a name like
"com.sun.star.Foo" refers to, which needs to be in the doxygen input.
Change-Id: I793bc59c8acfecf460e4addea7838c76a3ede77e
Diffstat (limited to 'odk/CustomTarget_doxygen.mk')
| -rw-r--r-- | odk/CustomTarget_doxygen.mk | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/odk/CustomTarget_doxygen.mk b/odk/CustomTarget_doxygen.mk index 7ff46dc130da..0577d1765efe 100644 --- a/odk/CustomTarget_doxygen.mk +++ b/odk/CustomTarget_doxygen.mk @@ -60,8 +60,11 @@ $(eval $(call gb_CustomTarget_register_targets,odk/docs,\ )) odk_idl_PREFIX := $(SRCDIR)/udkapi/ $(SRCDIR)/offapi/ +# note: generated_idl_chapter_refs.idl must be the _last_ input file! +# otherwise spurious references to it will appear in the output odk_idl_DOXY_INPUT := $(SRCDIR)/odk/pack/gendocu/idl/main.dox \ $(addsuffix com,$(odk_idl_PREFIX)) \ + $(SRCDIR)/odk/pack/gendocu/idl/generated_idl_chapter_refs.idl odk_idl_DOXY_WORKDIR := $(call gb_CustomTarget_get_workdir,odk/docs/idl)/ref # don't depend on the IDL files directly but instead on the udkapi/offapi |