kc3-lang/libxkbcommon/doc/Doxyfile.in
Branch :
Log
| Author | Commit | Date | CI | Message |
|---|---|---|---|---|
 |
9da1a2eb | 2025-05-16 10:33:43 | doc: Add license in generated doc | |
|
d018638d | 2025-05-16 09:35:39 | doc: Improve CSS | |
|
61a1e646 | 2025-05-15 17:24:50 | doc: Reformat release notes and include them in the HTML doc | |
|
bd552642 | 2025-05-15 17:20:44 | doc: Use custom alias to fix HTML tags unsupported by Doxygen Previous solution with `sed` is both overkilled and unreliable. Prefer a hack using Doxygen’s buit-ins, although we are not sure these are much more stable… 😓 | |
|
b5cde5c1 | 2025-02-05 11:47:56 | doc: Improve README | |
|
a93fd7db | 2025-02-05 11:43:37 | doc: Fix Doxygen config - Use classical layout without a side bar, which is the default in recent Doxygen versions. - Use Github-style heading IDs: more user-friendly and stable. - Enable the Javascript-base search engine. - Generate `sitemaps.xml`. - Fix CSS width incompatible with small devices. | |
|
e4b20b91 | 2024-03-15 18:57:32 | doc(keymap): Improve types & symbols sections - Add a diagram to illustrate how key types work. - Add examples to explain the key types mappings. - Add note for using `preserve` to tweak shortcuts. - Improve the key statement section. | |
 |
54f073ce | 2024-02-05 11:11:11 | doc: remove obsolete HTML_TIMESTAMP warning: Tag 'HTML_TIMESTAMP' at line 44 of file '/home/whot/xorg/lib/libxkbcommon/build/Doxyfile' has become obsolete. | |
 |
c1b6c79a | 2023-07-31 22:35:16 | 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> | |
|
fc664cf1 | 2023-05-13 05:30:11 | Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links | |
|
81842f7f | 2020-07-25 17:18:02 | doc: ignore rxkb, RXBK prefixes in doxygen Signed-off-by: Ran Benita <ran@unusedvar.com> | |
 |
41bea9ab | 2017-08-01 22:19:48 | 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> | |
|
4983dbcf | 2017-07-28 18:19:40 | 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> | |
 |
a2974d5f | 2016-03-15 11:20:35 | doc: Fix Doxygen include for srcdir != builddir Instead of giving Doxygen a series of absolute paths to the source files and a relative path to the output directory, run it from the source directory with purely relative paths to the source files, and give it an absolute path to the build directory. This fixes the parsing of README.md with a separate build directory, since the relative includes for doc/quick-guide.md and doc/compat.md don't resolve otherwise. Doxygen's INCLUDE_PATH turns out not to fix this either, since that's just a set of paths to open and parse, rather than an analogue to cpp's -I. Signed-off-by: Daniel Stone <daniels@collabora.com> | |
|
7bb425c1 | 2015-09-08 09:22:20 | doc/Doxyfile: explicitly set HTML_TIMESTAMP = NO YES was the default in older version. Having a timestamp hurts reproducible builds, and serves no purpose, so remove it. https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=789071 Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
7a15c0ef | 2015-09-08 09:21:32 | doc/Doxyfile: only keep non-default values Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
8c0d6c79 | 2015-09-08 09:17:16 | doc/Doxyfile: sync with latest version Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
0419f6e7 | 2014-10-18 14:50:49 | docs: make html output have a fixed width, hide footer It's hard to read text which stretches indefinitely. The footer is not adding much. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
494a8fbf | 2014-10-18 13:50:54 | README: move compatibility notes to their own page Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
046c802e | 2014-09-12 18:43:58 | compose: add xkbcommon-compose - API xkbcommon-compose is a Compose implementation for xkbcommon. It mostly behaves like libX11's Compose, but the support is somewhat low-level and is not transparent like in libX11. The user must add some supporting code in order to utilize it. The intended audience are users who use xkbcommon but not a full-blown input method. With this they can add Compose support in a straightforward manner, so they have a fairly complete keyboard input for Latin-like languages at least. See the header documentation for details. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
9c088df3 | 2014-09-22 15:45:26 | doc: disable alphabetical data structure index It is useless - we have very little data structures. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
805ed4e7 | 2014-09-22 15:31:51 | 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> | |
|
08d05799 | 2014-09-22 15:27:13 | doc: disable tree view It is redundant with the header navigation. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
0aeb1095 | 2014-09-18 21:09:41 | doc: order the modules better Explicitly specify the files in INPUT so that "X11 Support" appears after the main modules. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
770f3e4b | 2014-04-25 01:21:09 | doc: fix new doxygen version warnings Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
240fa418 | 2014-03-27 20:58:16 | build: trim down generated doxygen docs Remove the huge verbatim copies of the header files. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
806dbeac | 2014-03-23 15:04:51 | Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
aa3e8236 | 2014-03-23 14:32:12 | doc: add a quick guide to the library This is a nice intro to the documentation, and also preferably gently pushes users to the "proper way" of using the library, which can be confusing. See also: http://fooishbar.org/tell-me-about/xkbcommon-intro/ Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
6f06eb59 | 2013-06-19 21:13:52 | 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> | |
|
e8c0396f | 2013-03-05 13:16:30 | 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> | |
|
40e5de9a | 2013-03-05 12:01:48 | 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> | |
|
bde066b9 | 2012-10-11 18:13:56 | doc: use JAVADOC_AUTOBRIEF Don't have to type @brief all the time. Signed-off-by: Ran Benita <ran234@gmail.com> | |
|
108fa1c7 | 2012-09-22 15:02:54 | 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> |