doc: bring doxygen docs up-to-date

490b9a22 · Dimitris Lampridis · 59c7d16b · 490b9a22 · 490b9a22 · 490b9a22
Commit 490b9a22 authored Apr 28, 2023 by Dimitris Lampridis
6 changed files
--- a/software/lib/eeprom.c
+++ b/software/lib/eeprom.c
-/**
+/*
 * SPDX-FileCopyrightText: 2023 CERN (home.cern)
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
- *
+ */
+
+/**
 *	@file   eeprom.c
 * 	@brief  Library part that takes care of EEPROM serial number
 * 	@author Tomasz Włostowski

--- a/software/lib/liboattnusb-i.h
+++ b/software/lib/liboattnusb-i.h
-/**
+/*
 * SPDX-FileCopyrightText: 2023 CERN (home.cern)
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
- *
+ */
+
+/**
 * @file liboattnusb-i.h
 * @brief OASIS USB Attenuator driver library internal definitions
 * @author Tomasz Włostowski <tomasz.wlostowski@cern.ch>

--- a/software/lib/liboattnusb.c
+++ b/software/lib/liboattnusb.c
-/**
+/*
 * SPDX-FileCopyrightText: 2023 CERN (home.cern)
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
- *
+ */
+
+/**
 *	@file   liboattnusb.c
- * 	@brief  Library file for the msatt driver
+ * 	@brief  Library file for the oattnusb driver
 * 	@author Tomasz Włostowski
 *	@date	October 17th 2018
 */

--- a/software/lib/liboattnusb.h
+++ b/software/lib/liboattnusb.h
-/**
+/*
 * SPDX-FileCopyrightText: 2023 CERN (home.cern)
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
- *
+ */
+
+/**
 * @file liboattnusb.h
 * @brief OASIS USB Attenuator driver library interface
 *
 * This file describes the external interface to the OASIS USB Attenuator
- * driver and provides the definitios for proper communication
+ * driver and provides the definitions for proper communication
 * with the device
 *
 * @author Tomasz Włostowski <tomasz.wlostowski@cern.ch>
@@ -25,22 +27,22 @@ extern "C" {
 * \section intro_sec Introduction
 *
 * To be able to use the library API, you just need to include the
-* .liboattnusb.h header file. Linkage requires the flag
+* liboattnusb.h header file. Linkage requires the flag
 * `-loattnusb` and, in addition, `-lftdi1 -ludev`, as these are
 * used by the basic library. To wit:
 *
 *		gcc -o test test.c \
-*			-L /acc/local/L867/drv/oattn/1.0/lib \
-*			-I/acc/local/L867/drv/oattn/1.0/include \
+*			-L <install_path>/lib \
+*			-I<install_path>/include \
 *			-loattnusb -lftdi1 -ludev
 *
 * In case the static version of the library is preferred, a more
-* contorted incantation than  the above may be required to
-* the static library version in a foolproof manner:
+* contorted incantation than the above may be required to link to
+* the static library in a foolproof manner:
 *
 *		gcc -o test test.c \
-*			-L /acc/local/L867/drv/oattn/1.0/lib \
-*			-I/acc/local/L867/drv/oattn/1.0/include \
+*			-L <install_path>/lib \
+*			-I<install_path>/include \
 *			-lftdi1 -ludev \
 *			-Wl,--push-state,-static \
 *			-loattnusb \
@@ -64,7 +66,7 @@ enum oattnusb_value_enum {
 };

 /**
- * @brief Open a msatt device by LUN (not implemented)
+ * @brief Open a device by LUN (not implemented)
 *
 * A board is selected by lun, and a handle is returned for further
 * reference to it.
@@ -76,7 +78,7 @@ enum oattnusb_value_enum {
 int oattnusb_open(int lun);

 /**
- * @brief Open a msatt device
+ * @brief Open a device
 *
 * Open OASIS USB attenuator with given serial number.
 *
@@ -121,15 +123,15 @@ enum oattnusb_value_enum oattnusb_get_relay(int fd, int channel);
 int oattnusb_set_relay(int fd, int channel, enum oattnusb_value_enum val);

 /**
- * @brief Gets the number of channels (2 or 4)
+ * @brief Gets the number of channels
 * 
 * @param fd		Device handle identifying board
 * 
- * @return -1 on fail, 2 for MSATTN2 and 4 for MSATTN4
+ * @return OATTNUSB_NUM_CHANNELS
 */
 int oattnusb_get_nchannels(int fd);

-/* libmsatt version string */
+/* liboattnusb version string */
 extern const char * const liboattnusb_version_s;
 #ifdef __cplusplus
 }

--- a/software/lib/usb-enum.c
+++ b/software/lib/usb-enum.c
@@ -4,6 +4,11 @@
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

+/**
+ * @file usb-enum.c
+ * @brief OASIS USB Attenuator driver library interface
+ */
+
 #include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>

--- a/software/lib/usb-enum.h
+++ b/software/lib/usb-enum.h
-/**
+/*
 * SPDX-FileCopyrightText: 2023 CERN (home.cern)
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
- *
+ */
+
+/**
 * @file usb-enum.h
 * @brief OASIS USB Attenuator driver library interface
 *
 * This file describes the external interface to the OASIS USB Attenuator
- * driver and provides the definitios for proper communication
+ * driver and provides the definitions for proper communication
 * with the device
 *
 * @author David Cobas <dcobas AT cern.ch>