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

32 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
QUIET = YES
doc: drop the explicit input from the doxygen.in We pass in the input via the commandline, so having the files here is misleading. Replace it with an @INPUT@ - in autotools that one is ignored but it'll help meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-04-26 10:33:37 +10:00
INPUT = @INPUT@
doc: quote all paths in the doxygen file https://bugs.freedesktop.org/show_bug.cgi?id=103532 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-01 14:54:59 +10:00
IMAGE_PATH = "@top_srcdir@/doc/svg" \
"@top_srcdir@/doc/dot"
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: build doxygen output into "Documentation" Slightly more obvious than just "html". Main motivation here is that we want to provide the documentation as artifact from GitLab's CI, so having it unzip to something slightly more meaningful makes sense. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2018-07-03 13:40:45 +10:00
HTML_OUTPUT = Documentation
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: quote all paths in the doxygen file https://bugs.freedesktop.org/show_bug.cgi?id=103532 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-01 14:54:59 +10:00
DOTFILE_DIRS = "@top_srcdir@/doc/dot"
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: quote all paths in the doxygen file https://bugs.freedesktop.org/show_bug.cgi?id=103532 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-01 14:54:59 +10:00
HTML_HEADER = "@top_srcdir@/doc/style/header.html"
HTML_FOOTER = "@top_srcdir@/doc/style/footer.html"
HTML_EXTRA_STYLESHEET = "@top_srcdir@/doc/style/bootstrap.css" \
"@top_srcdir@/doc/style/customdoxygen.css" \
"@top_srcdir@/doc/style/libinputdoxygen.css"
USE_MDFILE_AS_MAINPAGE = "@top_srcdir@/README.md"
Reference in a new issue Copy permalink