summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohann <johann.koenig@duck.com>2018-12-13 13:04:09 -0800
committerJohann <johann.koenig@duck.com>2018-12-13 13:04:09 -0800
commit52e1465e995e3173e60e12b20a0feb0ea7fc9c10 (patch)
tree45a3c1a1f17c5cf91d875cc02d501a9d84b9154f
parent890c8a15d11be3141dff16c2c577622b59abbb66 (diff)
downloadlibvpx-52e1465e995e3173e60e12b20a0feb0ea7fc9c10.tar
libvpx-52e1465e995e3173e60e12b20a0feb0ea7fc9c10.tar.gz
libvpx-52e1465e995e3173e60e12b20a0feb0ea7fc9c10.tar.bz2
libvpx-52e1465e995e3173e60e12b20a0feb0ea7fc9c10.zip
doxygen: fix --disable-examples
Only include the sample code link when they are built. BUG=webm:1565 Change-Id: If13126b59953b51a76c964da4a8c58eb367f2dd7
-rw-r--r--examples.mk1
-rw-r--r--mainpage.dox2
-rw-r--r--usage_cx.dox2
-rw-r--r--usage_dx.dox2
4 files changed, 7 insertions, 0 deletions
diff --git a/examples.mk b/examples.mk
index 1187f147a..a1d4eb68c 100644
--- a/examples.mk
+++ b/examples.mk
@@ -404,3 +404,4 @@ CLEAN-OBJS += examples.doxy samples.dox $(ALL_EXAMPLES:.c=.dox)
DOCS-yes += examples.doxy samples.dox
examples.doxy: samples.dox $(ALL_EXAMPLES:.c=.dox)
@echo "INPUT += $^" > $@
+ @echo "ENABLED_SECTIONS += samples" >> $@
diff --git a/mainpage.dox b/mainpage.dox
index ec202fa4f..4b0dff087 100644
--- a/mainpage.dox
+++ b/mainpage.dox
@@ -25,8 +25,10 @@
release.
- The \ref readme contains instructions on recompiling the sample applications.
- Read the \ref usage "usage" for a narrative on codec usage.
+ \if samples
- Read the \ref samples "sample code" for examples of how to interact with the
codec.
+ \endif
- \ref codec reference
\if encoder
- \ref encoder reference
diff --git a/usage_cx.dox b/usage_cx.dox
index 92b0d34ef..b2220cfdd 100644
--- a/usage_cx.dox
+++ b/usage_cx.dox
@@ -8,6 +8,8 @@
\ref usage_deadline.
+ \if samples
\ref samples
+ \endif
*/
diff --git a/usage_dx.dox b/usage_dx.dox
index 883ce2492..85063f705 100644
--- a/usage_dx.dox
+++ b/usage_dx.dox
@@ -11,7 +11,9 @@
\ref usage_postproc based on the amount of free CPU time. For more
information on the <code>deadline</code> parameter, see \ref usage_deadline.
+ \if samples
\ref samples
+ \endif
\section usage_cb Callback Based Decoding