summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: include linux/input.h verbatim in the documentationPeter Hutterer2014-03-141-1/+1
| | | | | | | | 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>
* doc: add a placeholder man pagePeter Hutterer2013-12-093-0/+35
| | | | | | | | 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>
* doxygen: specifying builddir is not requiredGaetan Nadon2013-11-261-1/+1
| | | | | | | | 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>
* doxygen: fix 'dist' when the html docs have not yet been builtGaetan Nadon2013-11-251-1/+1
| | | | | | | | | | | | 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>
* doxygen: fix rebuild when not necessaryGaetan Nadon2013-11-251-4/+8
| | | | | | | | | 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>
* doxygen: fix error msg: 'find: `html': No such file or directory'Gaetan Nadon2013-11-251-1/+1
| | | | | | | | 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>
* doxygen: remove redundant "dist_noinst_DATA = libevdev.doxygen.in" statementGaetan Nadon2013-11-251-2/+0
| | | | | | | 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>
* doxygen: implement silent rules in the makefileGaetan Nadon2013-11-251-2/+2
| | | | | Signed-off-by: Gaetan Nadon <memsize@videotron.ca> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doxygen: invocation of doxygen fails due to hard coded pathGaetan Nadon2013-11-251-1/+1
| | | | | | | 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>
* doxygen: libevdev.doxygen must not be distributedGaetan Nadon2013-11-251-1/+1
| | | | | | | | | | | 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>
* Review/update .gitignore filesGaetan Nadon2013-11-191-0/+2
| | | | | | | | | | | | | | | | 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>
* Avoid shipping generated documentation twiceStephen Kitt2013-09-241-1/+1
| | | | | | | | | 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>
* doc: don't show enum values in doxygenPeter Hutterer2013-09-111-1/+1
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Add support for uinput device creationPeter Hutterer2013-08-291-1/+2
| | | | | | | | | | | | | | | | | | | | 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>
* doc: actually package generated documentationPeter Hutterer2013-08-291-1/+10
| | | | | | | | | | 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>
* Remove deprecated SYMBOL_CACHE_SIZE from doxygen.inDavid Herrmann2013-08-221-16/+0
| | | | | | | | | 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>
* doc: fix css for notes and return valuesPeter Hutterer2013-08-011-0/+9
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: fix two doxygen include paths to be source-relativePeter Hutterer2013-07-221-2/+2
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Add libevdev.css to EXTRA_DISTPeter Hutterer2013-07-221-1/+1
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: css changes for gnome webPeter Hutterer2013-07-061-5/+8
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Add a custom stylesheet to the documentation.Peter Hutterer2013-07-052-1/+216
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: tweak a few doxygen options, mainly to display the versionPeter Hutterer2013-07-041-4/+4
| | | | | | The rest is rather insignificant Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: set doxygen to quiet modePeter Hutterer2013-07-011-1/+1
| | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* Use doxygen instead of man pagesPeter Hutterer2013-06-272-0/+1885
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>