Commit graph

32 commits

Author SHA1 Message Date
Peter Hutterer
71bf23cdc4 doc: fix distcheck
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-06-05 11:15:15 +10:00
Peter Hutterer
deb52eb52f doc: add libinput's doxygen styles
Minor modifications to the style, but at least this is readable now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-06-05 10:56:45 +10:00
Peter Hutterer
d834a1f2b7 doc: drop the custom stylesheet
Revert back to the normal doxygen looks, even though they're pretty awful. But
at least they're consistent, the custom stylesheets had all sorts of weird
corner cases that didnt' render correctly and I don't have enough CSS
knowledge to fix this correctly.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-06-03 17:48:28 +10:00
Peter Hutterer
7ea9b09433 doc: a change of the CSS needs to trigger a doxygen rebuild
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-06-03 17:48:28 +10:00
Peter Hutterer
d05736765c doc: drop the HTML_TIMESTAMP
Allows for reproducible builds. Debian carries a patch for this, and the
timestamp doesn't really add much since the doc is either in sync with master
or represents the release tag. Might as well drop it.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-08-29 08:00:49 +10:00
Peter Hutterer
e11662ac72 doc: reduce doxygen file to the non-default settings
Makes it easier to check what we changed from the defaults.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-04-22 08:32:10 +10:00
Peter Hutterer
c8882c31c4 doc: update doxygen.in for current doxygen
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-11-13 11:06:08 +10:00
Peter Hutterer
f5c4de024d Mark the log functions with the printf format attribute
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: David Herrmann <dh.herrmann@gmail.com>
2014-06-05 15:15:12 +10:00
Peter Hutterer
4d975f9317 doc: include linux/input.h verbatim in the documentation
This makes it easier to look up what specific version libevdev was compiled
against.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
2014-03-14 09:38:18 +10:00
Peter Hutterer
94628309f9 doc: add a placeholder man page
We don't provide man pages (the ones created by doxygen are pretty
terrible) so provide a placeholder page to provide the minimum info and point
people in the right direction.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-12-09 08:46:24 +10:00
Gaetan Nadon
d15856c77a doxygen: specifying builddir is not required
For the scenarios the module supports it is not required to
be specified.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-26 09:43:35 +10:00
Gaetan Nadon
c495cb42c0 doxygen: fix 'dist' when the html docs have not yet been built
The reason why this did not work is that we do not have a fixed list
of html doc files and it would be  pain to maintain.

The 'find' hack gets a list of html files but only when the package
has already been built. Let's complement this hack with the
html/index.html file which act as a build trigger as it is the target name.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:40:05 +10:00
Gaetan Nadon
dd016ebc3f doxygen: fix rebuild when not necessary
Everytime make is invoked, doxygen is invoked to generate the html doc.

Dependencies are added so it does rebuild when necessary.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:25:32 +10:00
Gaetan Nadon
ebb70f42dc doxygen: fix error msg: 'find: `html': No such file or directory'
Every time a make target is run in the doc directory when the html dir
is absent, you get this error. Even with 'make clean'.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:45 +10:00
Gaetan Nadon
83d679f1a1 doxygen: remove redundant "dist_noinst_DATA = libevdev.doxygen.in" statement
All .in files in AC_CONFIG_FILES are distributed.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:30 +10:00
Gaetan Nadon
17eb113524 doxygen: implement silent rules in the makefile
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:24:00 +10:00
Gaetan Nadon
40dde58556 doxygen: invocation of doxygen fails due to hard coded path
The makefile does not use $(DOXYGEN) variable.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:23:52 +10:00
Gaetan Nadon
a0fc429f06 doxygen: libevdev.doxygen must not be distributed
It reflects the values on the build machine.
Same pattern as libevdev.pc vs libevdev.pc.in.

For example, in libevdev.doxygen:
HTML_EXTRA_STYLESHEET  = ./libevdev.css

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-25 10:23:45 +10:00
Gaetan Nadon
4f0f1ca68c Review/update .gitignore files
Merge potentially useful patterns taken from other projects.

Some application specific patterns were move to their respective directories.

The only noticeable change is that *.patch is ignore to prevent accidental
checkin of patches. The pattern "test-driver" could not be found and was
removed.

The test directory had not been updated since the move of all test cases
in a single binary.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-11-19 09:34:23 +10:00
Stephen Kitt
92b03c9da1 Avoid shipping generated documentation twice
Only add files to EXTRA_DIST, to avoid having a full copy of doc/html as
doc/html/html in the distributed tarball.

Signed-off-by: Stephen Kitt <skitt@debian.org>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-09-24 04:21:17 +10:00
Peter Hutterer
dab889781b doc: don't show enum values in doxygen
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-09-11 12:06:08 +10:00
Peter Hutterer
1acbfb3579 Add support for uinput device creation
This lets libevdev provide a relatively generic interface for the
creation of uinput devices so we don't need to duplicate this across
multiple projects.

Most of this is lifted from the current test implementation, with a
couple of minor changes.

EV_REP needs special handling:
   Kernel allows to set the EV_REP bit, it doesn't set REP_* bits (which we
   wrap anyway) but it will also set the default values (500, 33).

Device node is guessed based on the sysfs path:
   The sysfs path contains a eventN file, that corresponds to our
   /dev/input/eventN number. Use it so clients can quickly get the device
   node, without a libudev dependency.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-08-29 13:54:46 +10:00
Peter Hutterer
144b731202 doc: actually package generated documentation
Previous find command wouldn't actually list the generated documentation
files, so they'd be missing in the tarball.

...and add a dist-hook to make sure this won't happen during release.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
2013-08-29 11:13:49 +10:00
David Herrmann
0e1693ece3 Remove deprecated SYMBOL_CACHE_SIZE from doxygen.in
SYMBOL_CACHE_SIZE was removed in newer doxygen releases. We use the
default value, so simply drop it.

Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-08-22 16:24:07 +10:00
Peter Hutterer
bc73a98ca6 doc: fix css for notes and return values
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-08-01 13:53:01 +10:00
Peter Hutterer
e4dd720cfb doc: fix two doxygen include paths to be source-relative
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-22 10:50:20 +10:00
Peter Hutterer
c45d402979 Add libevdev.css to EXTRA_DIST
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-22 10:50:20 +10:00
Peter Hutterer
0a98e92a1d doc: css changes for gnome web
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-06 10:26:54 +10:00
Peter Hutterer
7cd644015c Add a custom stylesheet to the documentation.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-05 11:20:50 +10:00
Peter Hutterer
0fde598ef5 doc: tweak a few doxygen options, mainly to display the version
The rest is rather insignificant

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-04 11:38:56 +10:00
Peter Hutterer
44d8696e7c doc: set doxygen to quiet mode
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-07-01 08:33:53 +10:00
Peter Hutterer
479e16725d Use doxygen instead of man pages
Doxygen is bad for man pages, but having an online API documentation
is better and easier to maintain.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-06-27 10:41:54 +10:00