fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-20 06:50:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rename README to README.md, include properly from doxygen

Browse source 
As of doxygen 1.8.3 (Dec 2012) doxygen can include a README.md directly as
mainpage. This avoids the ugly doxygen bits we have in the current README.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2017-04-20 15:54:55 +10:00
parent 7b9aa96d02
commit 938aa25843
4 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.txt → README.md
View file

@ -1,5 +1,3 @@
/*!@mainpage
libinput
========
@ -94,5 +92,3 @@ libinput is licensed under the MIT license.
See the [COPYING](http://cgit.freedesktop.org/wayland/libinput/tree/COPYING)
file for the full license information.
*/

4
configure.ac
View file

@ -117,13 +117,13 @@ if test "x$build_documentation" = "xyes"; then
AC_MSG_CHECKING([for compatible doxygen version])
doxygen_version=`$DOXYGEN --version`
AS_VERSION_COMPARE([$doxygen_version], [1.6.0],
AS_VERSION_COMPARE([$doxygen_version], [1.8.3],
[AC_MSG_RESULT([no])
DOXYGEN=""],
[AC_MSG_RESULT([yes])],
[AC_MSG_RESULT([yes])])
if test "x$DOXYGEN" = "x"; then
AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.6+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])
AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.8.3+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation])
fi
AC_PATH_PROG(DOT, dot)

2
doc/Makefile.am
View file

@ -5,7 +5,7 @@ EXTRA_DIST = \
header_files = \
$(top_srcdir)/src/libinput.h \
$(top_srcdir)/README.txt \
$(top_srcdir)/README.md \
$(srcdir)/absolute-axes.dox \
$(srcdir)/absolute-coordinate-ranges.dox \
$(srcdir)/building.dox \

3
doc/libinput.doxygen.in
View file

@ -9,7 +9,7 @@ EXTRACT_STATIC = YES
MAX_INITIALIZER_LINES = 0
QUIET = YES
INPUT = @top_srcdir@/src/libinput.h \
@top_srcdir@/README.txt
@top_srcdir@/README.md
IMAGE_PATH = @top_srcdir@/doc/svg \
@top_srcdir@/doc/dot
GENERATE_HTML = YES
@ -28,3 +28,4 @@ HTML_FOOTER = @top_srcdir@/doc/style/footer.html
HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/style/bootstrap.css \
@top_srcdir@/doc/style/customdoxygen.css \
@top_srcdir@/doc/style/libinputdoxygen.css
USE_MDFILE_AS_MAINPAGE = @top_srcdir@/README.md