StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libxkbcommon/doc/Doxyfile.in

56 lines
1022 B
Plaintext
Raw Permalink Normal View History

Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NUMBER = @PACKAGE_VERSION@
build: make doxygen run from the source tree I couldn't find any other way to make this work! Signed-off-by: Ran Benita <ran234@gmail.com>
2017-08-01 13:19:48 -06:00
OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
doc: disable BRIEF_MEMBER_DESC It's easier to quickly go through the functions in a module this way. The names provide enough "brief description" to get someone to click for the full description. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-09-22 06:31:51 -06:00
BRIEF_MEMBER_DESC = NO
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc: use JAVADOC_AUTOBRIEF Don't have to type @brief all the time. Signed-off-by: Ran Benita <ran234@gmail.com>
2012-10-11 10:13:56 -06:00
JAVADOC_AUTOBRIEF = YES
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
OPTIMIZE_OUTPUT_FOR_C = YES
doc: use README as doxygen main page overview The doxygen page looked a bit dead, the README fills it nicely, and is already written in the markdown format which doxygen uses (I think?). Unfortunately the USE_MDFILE_AS_MAINPAGE doxygen config doesn't seem to do anything.. So we just add a {#mainpage} tag at the top of the README which isn't so bad. BUT we still need some config option (the no_extension=md part) so that doxygen will accept README instead of README.md or somesuch. And that requires an even newer release, 1.8.3.1, released 2013-01. But if an older version is used, it doesn't spew out warnings but just skips the README, which is fine. Signed-off-by: Ran Benita <ran234@gmail.com>
2013-03-05 04:16:30 -07:00
EXTENSION_MAPPING = no_extension=md
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
SORT_MEMBER_DOCS = NO
Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links
2023-05-12 21:30:11 -06:00
QUIET = $(DOXYGEN_QUIET)
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
WARN_IF_UNDOCUMENTED = NO
Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links
2023-05-12 21:30:11 -06:00
WARN_AS_ERROR = $(DOXYGEN_WARN_AS_ERROR)
build: change doxygen target to be properly dependency-based This hackery (thanks libinput) is clearer and more precise than the previous hackery. Signed-off-by: Ran Benita <ran234@gmail.com>
2017-07-28 09:19:40 -06:00
INPUT = @INPUT@
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc: Update Doxyfile It gives: Warning: Tag `SYMBOL_CACHE_SIZE' at line 346 of file doc/Doxyfile has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" So run 'doxygen -u' as suggested. Signed-off-by: Ran Benita <ran234@gmail.com>
2013-06-19 12:13:52 -06:00
FILE_PATTERNS = *.c \
*.h
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
RECURSIVE = YES
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
USE_MDFILE_AS_MAINPAGE = README.md
doc: update Doxyfile template to one from newer version We want to use the USE_MDFILE_AS_MAINPAGE option which was introduced in doxygen 1.8.3 (released 2012-12). Right now the new options are commented, otherwise older doxygen spews these these warnings, which can be ignored: warning: ignoring unsupported tag `USE_MDFILE_AS_MAINPAGE =' at line 794, file doc/Doxyfile warning: ignoring unsupported tag `MATHJAX_FORMAT =' at line 1210, file doc/Doxyfile warning: ignoring unsupported tag `EXTERNAL_SEARCH =' at line 1257, file doc/Doxyfile warning: ignoring unsupported tag `SEARCHENGINE_URL =' at line 1265, file doc/Doxyfile warning: ignoring unsupported tag `SEARCHDATA_FILE =' at line 1271, file doc/Doxyfile warning: ignoring unsupported tag `EXTERNAL_SEARCH_ID =' at line 1278, file doc/Doxyfile warning: ignoring unsupported tag `EXTRA_SEARCH_MAPPINGS =' at line 1287, file doc/Doxyfile Signed-off-by: Ran Benita <ran234@gmail.com>
2013-03-05 03:01:48 -07:00
build: trim down generated doxygen docs Remove the huge verbatim copies of the header files. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-27 12:58:16 -06:00
VERBATIM_HEADERS = NO
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc: disable alphabetical data structure index It is useless - we have very little data structures. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-09-22 06:45:26 -06:00
ALPHABETICAL_INDEX = NO
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc: Update Doxyfile It gives: Warning: Tag `SYMBOL_CACHE_SIZE' at line 346 of file doc/Doxyfile has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" So run 'doxygen -u' as suggested. Signed-off-by: Ran Benita <ran234@gmail.com>
2013-06-19 12:13:52 -06:00
IGNORE_PREFIX = xkb_ \
doc: ignore rxkb, RXBK prefixes in doxygen Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 08:18:02 -06:00
XKB_ \
rxkb_ \
RXKB_
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
build: make doxygen run from the source tree I couldn't find any other way to make this work! Signed-off-by: Ran Benita <ran234@gmail.com>
2017-08-01 13:19:48 -06:00
HTML_EXTRA_STYLESHEET = doc/doxygen-extra.css
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc: fix some Doxygen warnings ``` libxkbcommon/doc/introduction-to-xkb.md:67: warning: unable to resolve reference to 'rule-file-format' for \ref command libxkbcommon/doc/introduction-to-xkb.md:181: warning: unable to resolve reference to 'keymap-text-format-v1' for \ref command libxkbcommon/doc/rules-format.md:10: warning: unable to resolve reference to 'xkb-intro' for \ref command ``` Signed-off-by: Ran Benita <ran@unusedvar.com>
2023-07-31 13:35:16 -06:00
TIMESTAMP = NO
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc/Doxyfile: only keep non-default values Signed-off-by: Ran Benita <ran234@gmail.com>
2015-09-08 00:21:32 -06:00
ENUM_VALUES_PER_LINE = 1
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
doc/Doxyfile: only keep non-default values Signed-off-by: Ran Benita <ran234@gmail.com>
2015-09-08 00:21:32 -06:00
SEARCHENGINE = NO
Add support for building doxygen API documentation Simple HTML docs generated from the doxygen comments. After running 'make' or 'make doc', try firefox doc/html/index.html to see it (if you have doxygen). It's also installed with 'make install'. You can use --enable-docs or --disable-docs, or specifically --with-doxygen or --without-doxygen (autodetected, default yes). The docs are currently not distributed in the tarball, because I couldn't make it work properly in all cases :/ Signed-off-by: Ran Benita <ran234@gmail.com>
2012-09-22 06:02:54 -06:00
GENERATE_LATEX = NO
Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links
2023-05-12 21:30:11 -06:00
HAVE_DOT = YES
DOTFILE_DIRS = doc/diagrams
DOT_IMAGE_FORMAT = svg