Skip to content

Commit 666d53a

Browse files
committed
refactor: standardize doxygen briefs
Update the file-level \brief Doxygen tags across all 19 header and source files in the src/ directory to ensure consistent, highly detailed, and standardized documentation.
1 parent 7bcbcb2 commit 666d53a

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/fuse_local.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
/**
2828
* \file fuse_local.h
29-
* \brief FUSE related functions
29+
* \brief FUSE mounting and operations header
3030
*/
3131

3232
/* Initialise fuse */

src/link.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
/**
2828
* \file link.h
29-
* \brief link related structures and functions
29+
* \brief Link structure and handling functions header
3030
*/
3131

3232
#include <curl/curl.h>

src/network.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
/**
2828
* \file network.h
29-
* \brief network related functions
29+
* \brief Network transfer and cURL wrapper header
3030
*/
3131

3232
#include <curl/curl.h>

src/sonic.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
#define SONIC_H
2626
/**
2727
* \file sonic.h
28-
* \brief Sonic related function
28+
* \brief Airsonic / Subsonic server API integration header
2929
*/
3030

3131
typedef struct {

src/util.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
#define UTIL_H
2626
/**
2727
* \file util.h
28-
* \brief utility functions
28+
* \brief Utility functions and memory allocation wrappers header
2929
*/
3030

3131
#include <pthread.h>

0 commit comments

Comments
 (0)