Fix a few warnings from doxygen in the comments

In the logfiles you can find several warnings.
Most of them handle "\brief ." lines,
followed by an empty new line.
This commit is contained in:
Lutz Eichler
2017-05-06 23:10:50 +02:00
parent 4dbdc515b1
commit 8a794d0db3
6 changed files with 10 additions and 10 deletions
+1 -1
View File
@@ -14,7 +14,7 @@ pthread_mutex_t inputmutex[DEV_MAX] = { [0 ... DEV_MAX-1] = PTHREAD_MUTEX_INITIA
/// \brief .
///
/// \brief _start_dev get fw-info and pollrate; if available, install new firmware; get all hardware profiles
/// \brief _start_dev get fw-info and pollrate; if available, install new firmware; get all hardware profiles.
/// \param kb the normal kb pointer to the usbdevice. Is also valid for mice.
/// \param makeactive if set to 1, activate the device via setactive()
/// \return 0 if success, other else
+3 -3
View File
@@ -38,8 +38,8 @@ int rm_recursive(const char* path){
///
/// \brief _updateconnected Update the list of connected devices.
///
/// <devicepath> normally is /dev/input/ckb or /input/ckb.
/// \n Open the normal file under <devicepath>0/connected for writing.
/// \<devicepath\> normally is /dev/input/ckb or /input/ckb.
/// \n Open the normal file under \<devicepath\>0/connected for writing.
/// For each device connected, print its devicepath+number,
/// the serial number of the usb device and the usb name of the device connected to that usb interface.
/// \n eg:
@@ -48,7 +48,7 @@ int rm_recursive(const char* path){
///
/// Set the file ownership to root.
/// If the glob var gid is explicitly set to something different from -1 (the initial value), set file permission to 640, else to 644.
/// This is used if you start the daemon with --gid=<GID> Parameter.
/// This is used if you start the daemon with --gid=\<GID\> Parameter.
///
/// Because several independent threads may call updateconnected(), protect that procedure with locking/unlocking of \b devmutex.
///
+1 -1
View File
@@ -480,7 +480,7 @@ int usb_tryreset(usbdevice* kb){
}
///
/// \var hwload_mode is defined in device.c
/// hwload_mode is defined in device.c
///
extern int hwload_mode;
+1 -1
View File
@@ -241,7 +241,7 @@ int _usbsend(usbdevice* kb, const uchar* messages, int count, const char* file,
/// \param[OUT] in_msg Here comes the answer; The names represent the usb view, not the view of this function! So INput from usb is OUTput of this function.
/// \param[IN] file for debugging
/// \param[IN] line for debugging
/// \param[in] reset_stop global variable is read
/// \param[IN] reset_stop global variable is read
/// \return number of bytes read or zero on failure.
int _usbrecv(usbdevice* kb, const uchar* out_msg, uchar* in_msg, const char* file, int line);
+3 -3
View File
@@ -24,7 +24,7 @@ void MacroReader::startWorkInAThread(int macroNumber, QString macroPath, QPlainT
/// \class MacroReaderThread
///
void MacroReaderThread::readMacro(QString line) {
/// \detail We want to see the keys as they appear in the macroText Widget.
/// \details We want to see the keys as they appear in the macroText Widget.
///
/// Because it is possible to change the Focus via keyboard,
/// we must set the focus on each call.
@@ -37,8 +37,8 @@ void MacroReaderThread::readMacro(QString line) {
//////////
/// \brief MacroReaderThread::run is the standard main function for a thread.
/// Tries to open a file <macroPath><macroNumber> several times
/// (in this case, it should be possible the first time. (The code was recycled from kb.cpp).
/// Tries to open a file \<macroPath\>\<macroNumber\> several times
/// (in this case, it should be possible the first time (the code was recycled from kb.cpp).
///
/// While the file is open, read lines an signal them via metaObject() to the main thread.
/// When the file is closed by the sender, close it as reader and terminate.
+1 -1
View File
@@ -25,7 +25,7 @@ class MacroReaderThread : public QThread
//////////
/// \brief macroNumber
/// Filenames of nofity channels have the structure <input-device-path>/ckb1/notify<number>
/// Filenames of nofity channels have the structure <input-device-path>/ckb1/notify\<number\>
/// First part is hold in macroPath, the number is hold in macroNumber.
/// macroNumber may range from 0 to 9.
int macroNumber;