From fbf59878d6260ae39290c933c54401ea9cfe75ff Mon Sep 17 00:00:00 2001 From: Carl Philipp Klemm Date: Tue, 9 Jan 2024 14:05:14 +0100 Subject: [PATCH] documentation: fix some spelling --- README.md | 8 ++-- doc/DoxygenLayout.xml | 74 ++++++++++++++++---------------- doc/libeismulitplexer.doxygen.in | 2 +- doc/style.css | 27 ++++++++++++ eismultiplexer.h | 42 +++++++++--------- 5 files changed, 89 insertions(+), 64 deletions(-) create mode 100644 doc/style.css diff --git a/README.md b/README.md index 1c42740..f539bd5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # libeismultiplexer -libeismultiplexer is a shared library that allows you to control EISmulitplexer devices. +libeismultiplexer is a shared library that allows you to control EISmultiplexer devices. For questions or comments, please write to klemm@rhd-instruments.de -Full Online API documentation can be built with the "doc" target and is also avialable [here](http://uvos.xyz/kiss/libeismultiplexer). +Full Online API documentation can be built with the "doc" target and is also available [here](http://uvos.xyz/kiss/libeismultiplexer). A PDF with API documentation can be found [here](http://uvos.xyz/kiss/libeismultiplexer.pdf). ## Compile/Install @@ -33,6 +33,6 @@ to make the documentation: * make doc -### Licence +### License -librelaxisloader is licenced to you under the Apache License, Version 2.0 +librelaxisloader is licensed to you under the BSD-3-CLAUSE license diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 1af66ae..5e7c7bd 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -1,37 +1,15 @@ - + - + - + + + + + @@ -40,29 +18,29 @@ - + - + - + - + - + @@ -70,7 +48,7 @@ - + @@ -169,8 +147,8 @@ - - + + @@ -206,9 +184,10 @@ - + + @@ -254,6 +233,25 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/libeismulitplexer.doxygen.in b/doc/libeismulitplexer.doxygen.in index 374bfae..c2a59db 100644 --- a/doc/libeismulitplexer.doxygen.in +++ b/doc/libeismulitplexer.doxygen.in @@ -1201,7 +1201,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/doc/style.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..b2d6fec --- /dev/null +++ b/doc/style.css @@ -0,0 +1,27 @@ +body { + background-color: #CCC; + color: black; + margin: 0; +} + +div.contents { + margin-bottom: 10px; + padding: 12px; + margin-left: auto; + margin-right: auto; + max-width: 1024px; + background-color: white; + border-radius: 8px; +} + +#titlearea { +background-color: white; +} + +hr.footer { + display: none; +} + +.footer { + background-color: #AAA; +} diff --git a/eismultiplexer.h b/eismultiplexer.h index a6a9f7f..5f6f70b 100644 --- a/eismultiplexer.h +++ b/eismultiplexer.h @@ -32,9 +32,9 @@ #include /** -Api to controll EISmultiplexer devices. +API to control EISmultiplexer devices. * @defgroup API User API -* This api allows you to controll the EISmultiplexer device. +* This API allows you to control the EISmultiplexer device. * @{ */ @@ -58,50 +58,50 @@ struct eismultiplexer { }; /** - * @brief Attempts to connect to a EISmultiplexer device and initalizes a eismultiplexer struct - * @param muliplexer pointer to a eismultiplexer struct to initalize + * @brief Attempts to connect to a EISmultiplexer device and initializes a eismultiplexer struct + * @param multiplexer pointer to a eismultiplexer struct to initialize * @param serial The serial number of the device to connect to, or 0 for any - * @return 0 on sucess and < 0 on failure + * @return 0 on success and < 0 on failure */ int eismultiplexer_connect(struct eismultiplexer* muliplexer, uint16_t serial); /** - * @brief Conects the given channel(s) to the common inputs - * @param muliplexer pointer to a eismultiplexer struct - * @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B) - * @return 0 on sucess and < 0 on failure + * @brief Connects the given channel(s) to the common inputs + * @param multiplexer pointer to a eismultiplexer struct + * @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B) + * @return 0 on success and < 0 on failure */ int eismultiplexer_connect_channel(struct eismultiplexer* muliplexer, channel_t channel); /** - * @brief Conects the given channel(s) to the common inputs disconnecting all others - * @param muliplexer pointer to a eismultiplexer struct - * @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B) - * @return 0 on sucess and < 0 on failure + * @brief Connects the given channel(s) to the common inputs disconnecting all others + * @param multiplexer pointer to a eismultiplexer struct + * @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B) + * @return 0 on success and < 0 on failure */ int eismultiplexer_connect_channel_exclusive(struct eismultiplexer* muliplexer, channel_t channel); /** * @brief Disconnect the given channel(s) to the common inputs disconnecting all others - * @param muliplexer pointer to a eismultiplexer struct - * @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B) - * All channels can be dissconnected by passing CHANNEL_NONE - * @return 0 on sucess and < 0 on failure + * @param multiplexer pointer to a eismultiplexer struct + * @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B) + * All channels can be disconnected by passing CHANNEL_NONE + * @return 0 on success and < 0 on failure */ int eismultiplexer_disconnect_channel(struct eismultiplexer* muliplexer, channel_t channel); /** * @brief Returns the channels currently connected - * @param muliplexer pointer to a eismultiplexer struct + * @param multiplexer pointer to a eismultiplexer struct * @return channels connected as a bitfield */ channel_t eismultiplexer_get_connected(struct eismultiplexer* muliplexer); /** - * @brief Turns the led on the pcb on or off - * @param muliplexer pointer to a eismultiplexer struct + * @brief Turns the led on the PCB on or off + * @param multiplexer pointer to a eismultiplexer struct * @param on true to turn the led on, false to turn it off - * @return 0 on sucess and < 0 on failure + * @return 0 on success and < 0 on failure */ int eismultiplexer_set_led(struct eismultiplexer* muliplexer, bool on);