shithub: dav1d

Download patch

ref: eb31119d0726d1eb2c90e79ce321f03f162d2efc
parent: 6044a1ae4a606ec5940bbc28ada4a5727c9358dc
author: Janne Grunau <janne-vlc@jannau.net>
date: Wed Nov 28 17:46:23 EST 2018

add a Doxygen html target

--- /dev/null
+++ b/doc/Doxyfile.in
@@ -1,0 +1,19 @@
+PROJECT_NAME            = dav1d
+OUTPUT_DIRECTORY        = @DOXYGEN_OUTPUT@
+STRIP_FROM_PATH         = @DOXYGEN_STRIP@
+OUTPUT_LANGUAGE         = English
+TAB_SIZE                = 4
+EXTRACT_ALL             = YES
+OPTIMIZE_OUTPUT_FOR_C   = YES
+DOXYFILE_ENCODING       = UTF-8
+TYPEDEF_HIDES_STRUCT    = YES
+
+QUIET                   = YES
+WARNINGS                = YES
+WARN_IF_UNDOCUMENTED    = YES
+
+INPUT                   = @DOXYGEN_INPUT@
+FILE_PATTERNS           = *.h
+
+GENERATE_HTML           = YES
+GENERATE_LATEX          = NO
--- /dev/null
+++ b/doc/meson.build
@@ -1,0 +1,42 @@
+# Copyright © 2018, VideoLAN and dav1d authors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+doxygen = find_program('doxygen', required: false)
+
+if doxygen.found()
+    conf_data = configuration_data()
+    conf_data.set('DOXYGEN_INPUT', meson.source_root() + '/include/dav1d')
+    conf_data.set('DOXYGEN_STRIP', meson.source_root() + '/include/')
+    conf_data.set('DOXYGEN_OUTPUT', meson.current_build_dir())
+    doxyfile = configure_file(input: 'Doxyfile.in',
+                              output: 'Doxyfile',
+                              configuration: conf_data)
+
+    custom_target('doc',
+                  build_by_default: false,
+                  command: [doxygen, doxyfile],
+                  output: ['html']
+    )
+endif
+
--- a/meson.build
+++ b/meson.build
@@ -324,6 +324,8 @@
 
 subdir('include')
 
+subdir('doc')
+
 subdir('src')
 
 subdir('tools')