mirror of https://github.com/nirenjan/libx52.git
Remove consolidated API documentation page
This change ensures that there is a separate link to all libx52.h documentation. As a result, there is no longer a need to manually maintain a list of functions, structs, enums, etc. This also updates the main page to link directly to the documented files, rather than to the API page.pull/22/head
parent
7889124217
commit
a711f0a882
|
|
@ -29,6 +29,5 @@ EXTRA_DIST = libx52.h x52_commands.h x52_common.h README.md
|
||||||
# Add documentation files to the distribution
|
# Add documentation files to the distribution
|
||||||
EXTRA_DIST += \
|
EXTRA_DIST += \
|
||||||
doc/main.dox \
|
doc/main.dox \
|
||||||
doc/api.dox \
|
|
||||||
doc/caveats.dox \
|
doc/caveats.dox \
|
||||||
doc/integration.dox
|
doc/integration.dox
|
||||||
|
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
/**
|
|
||||||
@page libx52_api Application Programming Interface
|
|
||||||
|
|
||||||
This is the complete list of libx52 functions, structures and enumerations
|
|
||||||
in alphabetical order.
|
|
||||||
|
|
||||||
@section functions Functions
|
|
||||||
|
|
||||||
- @ref libx52_check_feature
|
|
||||||
- @ref libx52_exit
|
|
||||||
- @ref libx52_init
|
|
||||||
- @ref libx52_set_blink
|
|
||||||
- @ref libx52_set_brightness
|
|
||||||
- @ref libx52_set_clock
|
|
||||||
- @ref libx52_set_clock_format
|
|
||||||
- @ref libx52_set_clock_timezone
|
|
||||||
- @ref libx52_set_date
|
|
||||||
- @ref libx52_set_date_format
|
|
||||||
- @ref libx52_set_led_state
|
|
||||||
- @ref libx52_set_shift
|
|
||||||
- @ref libx52_set_text
|
|
||||||
- @ref libx52_set_time
|
|
||||||
- @ref libx52_update
|
|
||||||
- @ref libx52_vendor_command
|
|
||||||
|
|
||||||
@section structs Structures
|
|
||||||
|
|
||||||
- @ref libx52_device
|
|
||||||
|
|
||||||
@section enums Enumerations
|
|
||||||
|
|
||||||
- @ref libx52_clock_format
|
|
||||||
- @ref libx52_clock_id
|
|
||||||
- @ref libx52_date_format
|
|
||||||
- @ref libx52_error_code
|
|
||||||
- @ref libx52_feature
|
|
||||||
- @ref libx52_led_id
|
|
||||||
- @ref libx52_led_state
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|
@ -30,6 +30,10 @@ libx52 supports setting the following parameters on the joystick
|
||||||
|
|
||||||
@section api Application Programming Interface
|
@section api Application Programming Interface
|
||||||
|
|
||||||
See the @ref libx52_api for a complete list of all functions.
|
See the documentation for the folloowing files for a complete list of all
|
||||||
|
functions.
|
||||||
|
|
||||||
|
- libx52.h
|
||||||
|
- libx52util.h
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,17 @@
|
||||||
* SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
|
* SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file libx52.h
|
||||||
|
* @brief Functions, structures and enumerations for the Saitek X52 MFD & LED
|
||||||
|
* driver library.
|
||||||
|
*
|
||||||
|
* This file contains the type, enum and function prototypes for the Saitek X52
|
||||||
|
* driver library. These functions allow an application to connect to a supported
|
||||||
|
* X52/X52Pro joystick and control the MFD and LEDs.
|
||||||
|
*
|
||||||
|
* @author Nirenjan Krishnan (nirenjan@nirenjan.org)
|
||||||
|
*/
|
||||||
#ifndef LIBX52_H
|
#ifndef LIBX52_H
|
||||||
#define LIBX52_H
|
#define LIBX52_H
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue