[FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen

[Marvin Scholz]

On 24 Sep 2022, at 23:09, Marvin Scholz wrote:

> Add DISABLEDINSTHEADERS, a variable containing the headers of disabled
> libraries. This is needed so that Doxygen does not generate incomplete
> documentation when a component is disabled, which is quite unexpected
> behaviour and results in warnings due to, among other things, broken
> references.
> ---
>  Makefile     | 10 ++++++++++
>  doc/Makefile |  2 +-
>  2 files changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 61f79e27ae..26714950b7 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -110,7 +110,17 @@ include $(SRC_PATH)/$(1)/Makefile
>  include $(SRC_PATH)/ffbuild/library.mak
>  endef
>
> +define DODISABLEDSUBDIR
> +$(foreach V,$(SUBDIR_VARS),$(eval $(call RESET,$(V))))
> +SUBDIR := $(1)/
> +include $(SRC_PATH)/$(1)/Makefile
> +DISABLEDINSTHEADERS := $$(DISABLEDINSTHEADERS) $$(HEADERS:%=$$(SUBDIR)%)
> +endef
> +
> +DISABLEDFFLIBS := $(filter-out $(FFLIBS),$(ALLFFLIBS))
> +
>  $(foreach D,$(FFLIBS),$(eval $(call DOSUBDIR,lib$(D))))
> +$(foreach D,$(DISABLEDFFLIBS),$(eval $(call DODISABLEDSUBDIR,lib$(D))))
>
>  include $(SRC_PATH)/fftools/Makefile
>  include $(SRC_PATH)/doc/Makefile
> diff --git a/doc/Makefile b/doc/Makefile
> index 25774c7bad..d71a02e408 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -100,7 +100,7 @@ doc/%.3: doc/%.pod $(GENTEXI)
>
>  $(DOCS) doc/doxy/html: | doc/
>
> -DOXY_INPUT      = $(INSTHEADERS)
> +DOXY_INPUT      = $(INSTHEADERS) $(DISABLEDINSTHEADERS)
>  DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
>
>  doc/doxy/html: TAG = DOXY
> -- 
> 2.37.0 (Apple Git-136)

Ping for review, please.