fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-20 13:50:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
libinput/doc/api/libinput.doxygen.in

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

35 lines
1.2 KiB
Text
Raw Normal View History

doc: hook up doxygen to generate the public API documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-06 09:58:00 +10:00
PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NUMBER = @PACKAGE_VERSION@
PROJECT_BRIEF = "A wrapper library for input devices"
JAVADOC_AUTOBRIEF = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
doc: extract static members as well We only run doxygen over the public headers, so if we have a static function in those make sure they show up. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-19 11:06:40 +10:00
EXTRACT_STATIC = YES
doc: hook up doxygen to generate the public API documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-06 09:58:00 +10:00
MAX_INITIALIZER_LINES = 0
doc: enable warnings in doxygen We want to see missed links Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26 08:50:13 +10:00
WARNINGS = YES
doc: hook up doxygen to generate the public API documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-06 09:58:00 +10:00
QUIET = YES
doc: move the meson.build in as subdir() Doing so means we can ditch the specific input list for doxygen and just copy all files over into our builddir/doc/ subdir, then use that subdirectory as input data. This relies on meson putting a subdir() into a subdirectory in the build directory. This isn't technically guaranteed but I also suspect that if meson ever changes that, lots of other projects will break. Even in that case we should build just fine since we now filter for *.h and *.dox and don't copy any other doxygen-commented files into the builddir anyway. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-06 10:47:18 +10:00
INPUT = "@builddir@"
IMAGE_PATH = "@builddir@"
doc/api: fix the doxygen output handling Using output: ['.'] broke ninja after ninja clean - it removed the whole directory and thus the meson-generated configure_files (i.e. all the doxygen sources we copied). ninja didn't know how to build those. Fix this by rearranging the doxygen output to build into a different directory now and setting the output to that. This doesn't exactly *fix* things since that directory is no longer removed during ninja clean, but at least the build no longer fails. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-09-29 17:33:36 +10:00
OUTPUT_DIRECTORY = doc
doc: hook up doxygen to generate the public API documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-06 09:58:00 +10:00
GENERATE_HTML = YES
doc/api: fix the doxygen output handling Using output: ['.'] broke ninja after ninja clean - it removed the whole directory and thus the meson-generated configure_files (i.e. all the doxygen sources we copied). ninja didn't know how to build those. Fix this by rearranging the doxygen output to build into a different directory now and setting the output to that. This doesn't exactly *fix* things since that directory is no longer removed during ninja clean, but at least the build no longer fails. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-09-29 17:33:36 +10:00
HTML_OUTPUT = html
doc: disable the search engine/search box It was just floating around lonely there and I doubt anyone really used it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-02-23 07:36:06 +10:00
SEARCHENGINE = NO
doc: document the calibration as well Requires MathJax for client-side, but that's an easy dependency to accept and better than requiring Latex to build the documentation. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-12-22 12:11:46 +10:00
USE_MATHJAX = YES
doc: specify the https path for mathjax freedesktop.org always serves https for the documentation. if Mathjax is pulled in from http, browsers reject it [1] Let's take the default doxygen value but just add the https to it. In the future we should just ship a copy of mathjax with our documentation. [1] https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content/How_to_fix_website_with_mixed_content Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Wheres-my-beer-by: Yong Bakos <ybakos@humanoriented.com> Reviewed-by: Yong Bakos <ybakos@humanoriented.com>
2016-09-14 10:18:16 +10:00
MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
doc: hook up doxygen to generate the public API documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-06 09:58:00 +10:00
GENERATE_LATEX = NO
doc: ignore LIBINPUT_ATTRIBUTE_PRINTF in doxygen Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-06-12 11:42:25 +10:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
doc: remove unnecessary linebreak in doxygen file Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-11-23 10:38:45 +10:00
PREDEFINED = LIBINPUT_ATTRIBUTE_PRINTF(f, a)= \
doc: update for latest doxygen doxygen -u, no manual interference. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-10-30 15:16:40 +10:00
LIBINPUT_ATTRIBUTE_DEPRECATED
doc: move the meson.build in as subdir() Doing so means we can ditch the specific input list for doxygen and just copy all files over into our builddir/doc/ subdir, then use that subdirectory as input data. This relies on meson putting a subdir() into a subdirectory in the build directory. This isn't technically guaranteed but I also suspect that if meson ever changes that, lots of other projects will break. Even in that case we should build just fine since we now filter for *.h and *.dox and don't copy any other doxygen-commented files into the builddir anyway. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-06 10:47:18 +10:00
DOTFILE_DIRS = "@builddir@"
doc: document the device quirks Add some documentation for the most common quirks or at least the ones that the user may eventually see or have to set. Drop the git commit hash into the docs to make sure it's spelled out that the quirks are only valid for that commit. Adding something with @include* requires the EXAMPLE_PATH to be set. Doxygen doesn't parse markdown in @includedoc so we have to insert the commit as normal HTML tag. Related to https://gitlab.freedesktop.org/libinput/libinput/issues/87 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-20 15:30:00 +10:00
EXAMPLE_PATH = "@builddir@"
doc: we don't need the Namespaces doxygen page Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-26 13:56:15 +10:00
SHOW_NAMESPACES = NO
doc/api: set HAVE_DOT to YES dot is required in meson.build, so we can hardcoded it here Fixes: libinput/build/doc/api/libinput.h:4087: warning: ignoring \dot command because HAVE_DOT is not set Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2023-01-10 13:23:56 +10:00
HAVE_DOT = YES
doc: use bootstrap for doxygen styling Makes the documentation less of an eyesore. Header/footer from: https://github.com/Velron/doxygen-bootstrapped, Apache-licensed Bootstrap style from: https://bootswatch.com/paper/, MIT licensed Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2015-07-16 11:22:36 +10:00
doc: move the meson.build in as subdir() Doing so means we can ditch the specific input list for doxygen and just copy all files over into our builddir/doc/ subdir, then use that subdirectory as input data. This relies on meson putting a subdir() into a subdirectory in the build directory. This isn't technically guaranteed but I also suspect that if meson ever changes that, lots of other projects will break. Even in that case we should build just fine since we now filter for *.h and *.dox and don't copy any other doxygen-commented files into the builddir anyway. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-06 10:47:18 +10:00
HTML_HEADER = "@builddir@/header.html"
HTML_FOOTER = "@builddir@/footer.html"
HTML_EXTRA_STYLESHEET = "@builddir@/bootstrap.css" \
"@builddir@/customdoxygen.css" \
"@builddir@/libinputdoxygen.css"
Reference in a new issue Copy permalink