Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
From: Marvin Scholz <epirat07@gmail.com>
To: ffmpeg-devel@ffmpeg.org
Cc: Marvin Scholz <epirat07@gmail.com>
Subject: [FFmpeg-devel] [PATCH] Makefile: Build complete doc with Doxygen
Date: Sat, 24 Sep 2022 23:09:12 +0200
Message-ID: <20220924210913.5007-1-epirat07@gmail.com> (raw)

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)

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

             reply	other threads:[~2022-09-24 21:09 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-24 21:09 Marvin Scholz [this message]
2022-10-11 13:27 ` Marvin Scholz
2022-11-08 13:43 ` Marvin Scholz
2022-11-16 17:21 ` Marvin Scholz
2022-11-24 22:00   ` Jan Ekström

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220924210913.5007-1-epirat07@gmail.com \
    --to=epirat07@gmail.com \
    --cc=ffmpeg-devel@ffmpeg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git