Skip to content

Commit 41ccd4c

Browse files
committed
consistently use @returns code documentation tag
1 parent ee7c879 commit 41ccd4c

File tree

9 files changed

+11
-11
lines changed

9 files changed

+11
-11
lines changed

etc/afpd/dircache.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -814,7 +814,7 @@ void dircache_remove_children(const struct vol *vol, struct dir *dir)
814814
*
815815
* @param reqsize (r) requested maximum size from afp.conf
816816
*
817-
* @return 0 on success, -1 on error
817+
* @returns 0 on success, -1 on error
818818
*/
819819
int dircache_init(int reqsize)
820820
{

etc/afpd/directory.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ void dir_free_invalid_q(void)
923923
*
924924
* @param vol (r) volume pointer
925925
* @param dir (rw) directory/file entry to remove from cache
926-
* @return 0 on success
926+
* @returns 0 on success
927927
*/
928928
int dir_remove(const struct vol *vol, struct dir *dir)
929929
{

etc/afpd/fork.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ int afp_bytelock_ext(AFPObj *obj, char *ibuf, size_t ibuflen, char *rbuf,
861861
* @param rbuf (r) data buffer
862862
* @param rbuflen (rw) in: number of bytes to read, out: bytes read
863863
*
864-
* @return AFP status code
864+
* @returns AFP status code
865865
*/
866866
static int read_file(const struct ofork *ofork, int eid, off_t offset,
867867
char *rbuf, size_t *rbuflen)

etc/afpd/volume.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ extern int afprun(char *cmd, int *outfd);
7575
* @brief Read band-size info from Info.plist XML file of an TM sparsebundle
7676
*
7777
* @param path (r) path to Info.plist file
78-
* @return band-size in bytes, -1 on error
78+
* @returns band-size in bytes, -1 on error
7979
*/
8080
static long long int get_tm_bandsize(const char *path)
8181
{
@@ -121,7 +121,7 @@ static long long int get_tm_bandsize(const char *path)
121121
* @brief Return number on entries in a directory
122122
*
123123
* @param path (r) path to dir
124-
* @return number of entries, -1 on error
124+
* @returns number of entries, -1 on error
125125
*/
126126
static long long int get_tm_bands(const char *path)
127127
{
@@ -171,7 +171,7 @@ static long long int get_tm_bands(const char *path)
171171
* appends X bytes to a file (in fork.c).
172172
*
173173
* @param vol (rw) volume to calculate
174-
* @return 0 on success, -1 on error
174+
* @returns 0 on success, -1 on error
175175
*/
176176
static int get_tm_used(struct vol *restrict vol)
177177
{

etc/cnid_dbd/cnid_metad.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ static struct server *test_usockfn(const char *path)
164164
* @param[in] volpath Path of AFP volume
165165
* @param[in] username Optional username, may be NULL
166166
*
167-
* @return 0 on success, -1 on error
167+
* @returns 0 on success, -1 on error
168168
*/
169169
int maybe_start_dbd(const AFPObj *obj, char *dbdpn, const char *volpath,
170170
const char *username)

libatalk/dsi/dsi_stream.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ int dsi_stream_send(DSI *dsi, void *buf, size_t length)
644644
*
645645
* @param dsi (rw) DSI handle
646646
*
647-
* @return DSI function on success, 0 on failure
647+
* @returns DSI function on success, 0 on failure
648648
*/
649649
int dsi_stream_receive(DSI *dsi)
650650
{

libatalk/util/netatalk_conf.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -604,7 +604,7 @@ static char *volxlate(const AFPObj *obj,
604604
* Example:
605605
* user1 user2, user3, "@group1", "@group2", "@group3", "user name1", "@group name1"
606606
* A NULL argument allows everybody to have access.
607-
* @return three things:
607+
* @returns three things:
608608
* -1: no list
609609
* 0: list exists, but name isn't in it
610610
* 1: in list

libatalk/util/server_child.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ server_child_t *server_child_alloc(int connections)
104104

105105
/*!
106106
* @brief add a child
107-
* @return pointer to struct server_child_data on success, NULL on error
107+
* @returns pointer to struct server_child_data on success, NULL on error
108108
*/
109109
afp_child_t *server_child_add(server_child_t *children, pid_t pid, int ipc_fd)
110110
{

libatalk/util/unix.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ int run_cmd(const char *cmd, char **cmd_argv)
113113
/*!
114114
* @brief Fork, exit parent, setsid(), chdir("/"), close all fds
115115
*
116-
* @return -1 on failure, but you can't do much except exit in that case
116+
* @returns -1 on failure, but you can't do much except exit in that case
117117
* since we may already have forked
118118
*/
119119
int daemonize(void)

0 commit comments

Comments
 (0)