office-gobmx/odk/CustomTarget_doxygen.mk
Christian Lohmaier 83d3f9b819 use windows doxygen in wsl-as-helper case
basically reverts f7fe6a0bed

avoiding the penalty for accessing files in the windows-realm from
within the wsl-container significantly accelerates the doc-generation

Change-Id: I95af905bda7225a9c1924a41e952656dffbfbc0b
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167279
Tested-by: Jenkins
Reviewed-by: Christian Lohmaier <lohmaier+LibreOffice@googlemail.com>
2024-05-07 17:08:44 +02:00

104 lines
4.6 KiB
Makefile

# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
$(eval $(call gb_CustomTarget_CustomTarget,odk/docs))
odk_cpp_INCDIRLIST := sal salhelper rtl osl typelib uno cppu cppuhelper
odk_cpp_INCFILELIST := com/sun/star/uno/Any.h \
com/sun/star/uno/Any.hxx \
com/sun/star/uno/genfunc.h \
com/sun/star/uno/genfunc.hxx \
com/sun/star/uno/Reference.h \
com/sun/star/uno/Reference.hxx \
com/sun/star/uno/Sequence.h \
com/sun/star/uno/Sequence.hxx \
com/sun/star/uno/Type.h \
com/sun/star/uno/Type.hxx
# Cygwin Doxygen needs unix paths, wsl-as-helper works in windows-realm
odk_cygwin_path = $(if $(MSYSTEM),$(1),$(call gb_Helper_cyg_path,$(1)))
odk_cpp_PREFIX := $(call odk_cygwin_path,$(INSTDIR)/$(SDKDIRNAME)/include/)
odk_cpp_DOXY_INPUT := $(call odk_cygwin_path,$(SRCDIR)/odk/docs/cpp/main.dox \
$(SRCDIR)/include/sal/log-areas.dox \
$(addprefix $(odk_cpp_PREFIX),$(odk_cpp_INCDIRLIST) $(odk_cpp_INCFILELIST)))
odk_cpp_DOXY_WORKDIR := $(call odk_cygwin_path,$(gb_CustomTarget_workdir)/odk/docs/cpp/ref)
$(eval $(call gb_CustomTarget_register_targets,odk/docs,\
cpp/Doxyfile \
cpp/doxygen.log \
))
$(gb_CustomTarget_workdir)/odk/docs/cpp/Doxyfile : \
$(SRCDIR)/odk/docs/cpp/Doxyfile \
$(gb_Module_CURRENTMAKEFILE)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),SED,1)
$(call gb_Trace_StartRange,$(subst $(WORKDIR)/,,$@),SED)
sed -e 's!^INPUT = %$$!INPUT = $(odk_cpp_DOXY_INPUT)!' \
-e 's!^OUTPUT_DIRECTORY = %$$!OUTPUT_DIRECTORY = $(odk_cpp_DOXY_WORKDIR)!' \
-e 's!^PROJECT_BRIEF = %$$!PROJECT_BRIEF = "$(PRODUCTNAME) $(PRODUCTVERSION) SDK C/C++ API Reference"!' \
-e 's!^PROJECT_NAME = %$$!PROJECT_NAME = $(PRODUCTNAME)!' \
-e 's!^QUIET = %$$!QUIET = $(if $(verbose),NO,YES)!' \
-e 's!^STRIP_FROM_PATH = %$$!STRIP_FROM_PATH = $(odk_cpp_PREFIX)!' \
$< > $@
$(call gb_Trace_EndRange,$(subst $(WORKDIR)/,,$@),SED)
$(gb_CustomTarget_workdir)/odk/docs/cpp/doxygen.log : \
$(gb_CustomTarget_workdir)/odk/docs/cpp/Doxyfile \
$(SRCDIR)/include/sal/log-areas.dox \
$(SRCDIR)/odk/docs/cpp/main.dox \
$(call gb_Package_get_target,odk_headers) \
$(call gb_Package_get_target,odk_headers_generated)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),GEN,1)
$(call gb_Trace_StartRange,$(subst $(WORKDIR)/,,$@),GEN)
rm -rf $(odk_cpp_DOXY_WORKDIR)/ && $(DOXYGEN) $< > $@
$(call gb_Trace_EndRange,$(subst $(WORKDIR)/,,$@),GEN)
$(eval $(call gb_CustomTarget_register_targets,odk/docs,\
idl/Doxyfile \
idl/doxygen.log \
))
odk_idl_PREFIX := $(call odk_cygwin_path,$(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 := $(call odk_cygwin_path,$(SRCDIR)/odk/docs/idl/main.dox \
$(addsuffix com,$(odk_idl_PREFIX)) \
$(addsuffix org,$(odk_idl_PREFIX)) \
$(SRCDIR)/odk/docs/idl/generated_idl_chapter_refs.idl)
odk_idl_DOXY_WORKDIR := $(call odk_cygwin_path,$(gb_CustomTarget_workdir)/odk/docs/idl/ref)
# don't depend on the IDL files directly but instead on the udkapi/offapi
# which will get rebuilt when any IDL file changes
$(gb_CustomTarget_workdir)/odk/docs/idl/Doxyfile : \
$(SRCDIR)/odk/docs/idl/Doxyfile \
$(call gb_UnoApi_get_target,udkapi) \
$(call gb_UnoApi_get_target,offapi) \
$(gb_Module_CURRENTMAKEFILE)
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),SED,1)
$(call gb_Trace_StartRange,$(subst $(WORKDIR)/,,$@),SED)
sed -e 's!^INPUT = %$$!INPUT = $(odk_idl_DOXY_INPUT)!' \
-e 's!^OUTPUT_DIRECTORY = %$$!OUTPUT_DIRECTORY = $(odk_idl_DOXY_WORKDIR)!' \
-e 's!^PROJECT_BRIEF = %$$!PROJECT_BRIEF = "$(PRODUCTNAME) $(PRODUCTVERSION) SDK API Reference"!' \
-e 's!^PROJECT_NAME = %$$!PROJECT_NAME = $(PRODUCTNAME)!' \
-e 's!^QUIET = %$$!QUIET = $(if $(verbose),NO,YES)!' \
-e 's!^STRIP_FROM_PATH = %$$!STRIP_FROM_PATH = $(odk_idl_PREFIX)!' \
-e 's!^SHORT_NAMES = %$$!SHORT_NAMES = $(if $(filter WNT,$(OS)),YES,NO)!' \
$< > $@
$(call gb_Trace_EndRange,$(subst $(WORKDIR)/,,$@),SED)
$(gb_CustomTarget_workdir)/odk/docs/idl/doxygen.log : \
$(gb_CustomTarget_workdir)/odk/docs/idl/Doxyfile \
$(SRCDIR)/odk/docs/idl/main.dox
$(call gb_Output_announce,$(subst $(WORKDIR)/,,$@),$(true),GEN,1)
$(call gb_Trace_StartRange,$(subst $(WORKDIR)/,,$@),GEN)
rm -rf $(odk_idl_DOXY_WORKDIR)/ && $(DOXYGEN) $< > $@
$(call gb_Trace_EndRange,$(subst $(WORKDIR)/,,$@),GEN)
# vim: set noet sw=4 ts=4: