[CI] Fixing some more doxygen warnings.

This commit is contained in:
Dave Davenport 2019-09-30 10:57:23 +02:00
parent 0a0556c765
commit 8590a7ccf2
3 changed files with 13 additions and 9 deletions

View File

@ -362,14 +362,15 @@ char * rofi_theme_parse_prepare_file ( const char *file, const char *parent_file
void rofi_theme_parse_process_conditionals ( void ); void rofi_theme_parse_process_conditionals ( void );
/** /**
* @parent Target theme tree * @param parent target theme tree
* @parent child source theme three * @param child source theme three
* *
* Merge all the settings from child into parent. * Merge all the settings from child into parent.
*/ */
void rofi_theme_parse_merge_widgets ( ThemeWidget *parent, ThemeWidget *child ); void rofi_theme_parse_merge_widgets ( ThemeWidget *parent, ThemeWidget *child );
/** /**
* @type the media type to parse. * @param type the media type to parse.
* *
* Returns the media type described by type. * Returns the media type described by type.
*/ */

View File

@ -25,21 +25,22 @@
* *
*/ */
#ifndef ROFI_TIMINGS_H
#define ROFI_TIMINGS_H
#include <config.h>
/** /**
* @defgroup TIMINGS Timings * @defgroup TIMINGS Timings
* @ingroup HELPERS * @ingroup HELPERS
* @{ * @{
*/ */
#ifndef ROFI_TIMINGS_H
#define ROFI_TIMINGS_H
#include <config.h>
/** /**
* Init the timestamping mechanism . * Init the timestamping mechanism .
* implementation. * implementation.
*/ */
void rofi_timings_init ( void ); void rofi_timings_init ( void );
/** /**
* @param file filename tick originates from
* @param str function name. * @param str function name.
* @param line line number * @param line line number
* @param msg message * @param msg message
@ -92,5 +93,5 @@ void rofi_timings_quit ( void );
*/ */
#define TICK_N( a ) #define TICK_N( a )
/*@}*/
#endif // ROFI_TIMINGS_H #endif // ROFI_TIMINGS_H
/*@}*/

View File

@ -168,6 +168,7 @@ static void delete_ssh ( const char *host )
} }
/** /**
* @param path Path of the known host file.
* @param retv list of hosts * @param retv list of hosts
* @param length pointer to length of list [in][out] * @param length pointer to length of list [in][out]
* *
@ -453,11 +454,12 @@ static void parse_ssh_config_file ( SSHModePrivateData *pd, const char *filename
} }
/** /**
* @param pd The plugin data handle
* @param length The number of found ssh hosts [out] * @param length The number of found ssh hosts [out]
* *
* Gets the list available SSH hosts. * Gets the list available SSH hosts.
* *
* @return an array of strings containing all the hosts. * @returns an array of strings containing all the hosts.
*/ */
static SshEntry * get_ssh ( SSHModePrivateData *pd, unsigned int *length ) static SshEntry * get_ssh ( SSHModePrivateData *pd, unsigned int *length )
{ {