]> granicus.if.org Git - libvpx/commitdiff
doxygen: fix --disable-examples
authorJohann <johann.koenig@duck.com>
Thu, 13 Dec 2018 21:04:09 +0000 (13:04 -0800)
committerJohann <johann.koenig@duck.com>
Thu, 13 Dec 2018 21:04:09 +0000 (13:04 -0800)
Only include the sample code link when they are built.

BUG=webm:1565

Change-Id: If13126b59953b51a76c964da4a8c58eb367f2dd7

examples.mk
mainpage.dox
usage_cx.dox
usage_dx.dox

index 1187f147ae5e07854076ca708cd6aa607939cfd7..a1d4eb68c2df615c6fb332bed77391086b5decd8 100644 (file)
@@ -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" >> $@
index ec202fa4fb50370e1f24a52d41329926e99810b1..4b0dff08710dbfc0f06f13c1014313ebcfc859dc 100644 (file)
     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
index 92b0d34ef4d59197684f96e7649368c9b59320b2..b2220cfddebb8142e1ecd5976c36902211d1e605 100644 (file)
@@ -8,6 +8,8 @@
     \ref usage_deadline.
 
 
+    \if samples
     \ref samples
+    \endif
 
 */
index 883ce24926f0cc8dbfeb71adb189c1943ddf0b61..85063f705b6cf1a700ab02f9d3da1bc84e3fa528 100644 (file)
@@ -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