libinput/doc/libinput.doxygen.in

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
EXTRACT_STATIC         = YES
MAX_INITIALIZER_LINES  = 0
QUIET                  = YES
INPUT                  = @top_srcdir@/src/libinput.h \
			 @top_srcdir@/README.txt
IMAGE_PATH             = @top_srcdir@/doc/svg \
			 @top_srcdir@/doc/dot
GENERATE_HTML          = YES
USE_MATHJAX            = YES
MATHJAX_RELPATH        = https://cdn.mathjax.org/mathjax/latest
GENERATE_LATEX         = NO
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = LIBINPUT_ATTRIBUTE_PRINTF(f, \
                         a)= \
                         LIBINPUT_ATTRIBUTE_DEPRECATED
DOTFILE_DIRS           = @top_srcdir@/doc/dot

HTML_HEADER = @top_srcdir@/doc/style/header.html
HTML_FOOTER = @top_srcdir@/doc/style/footer.html
HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/style/customdoxygen.css \
			@top_srcdir@/doc/style/bootstrap.css
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: include README as mainpage doxygen supports markdown so we can expand the README with general interesting information in markdown format and have it be the front page of the documentation at the same time. This requires renaming README to README.txt, but that's a relatively small price to pay. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Jonas Ådahl <jadahl@gmail.com> 2014-12-09 13:19:54 +10:00			`INPUT = @top_srcdir@/src/libinput.h \`
			`@top_srcdir@/README.txt`
doc: specify the IMAGE_PATH relative to the source Fixes doxygen build with custom builddirs Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-01-15 11:43:04 +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: 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: 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			`PREDEFINED = LIBINPUT_ATTRIBUTE_PRINTF(f, \`
			`a)= \`
			`LIBINPUT_ATTRIBUTE_DEPRECATED`
doc: move DOTFILE_DIRS to libinput.doxygen.in We specify a bunch of other (static) things in the .in file, let's be consistent. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-01-15 11:43:31 +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
			`HTML_HEADER = @top_srcdir@/doc/style/header.html`
			`HTML_FOOTER = @top_srcdir@/doc/style/footer.html`
			`HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/style/customdoxygen.css \`
			`@top_srcdir@/doc/style/bootstrap.css`