diff options
author | Janne Grunau <janne-vlc@jannau.net> | 2018-11-29 00:46:23 +0300 |
---|---|---|
committer | Ronald S. Bultje <rsbultje@gmail.com> | 2018-11-29 02:05:11 +0300 |
commit | eb31119d0726d1eb2c90e79ce321f03f162d2efc (patch) | |
tree | 0cbe5945474f896e5345e0f99b12df62936f4d1c /doc | |
parent | 6044a1ae4a606ec5940bbc28ada4a5727c9358dc (diff) |
add a Doxygen html target
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Doxyfile.in | 19 | ||||
-rw-r--r-- | doc/meson.build | 42 |
2 files changed, 61 insertions, 0 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in new file mode 100644 index 0000000..ffb374c --- /dev/null +++ b/doc/Doxyfile.in @@ -0,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 diff --git a/doc/meson.build b/doc/meson.build new file mode 100644 index 0000000..742d03a --- /dev/null +++ b/doc/meson.build @@ -0,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 + |