Skip to content

Commit

Permalink
Comments
Browse files Browse the repository at this point in the history
netbuf:
- Agreement between API comments in header file and c files.
- Use () for function names.
  • Loading branch information
gperciva committed Feb 24, 2024
1 parent 3ed5aa9 commit 5a859b1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions libcperciva/netbuf/netbuf_read.c
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ netbuf_read_init(int s)

/**
* netbuf_read_init2(s, ssl):
* Behave like netbuf_read_init if ${ssl} is NULL. If the SSL context ${ssl}
* is not NULL, use it and ignore ${s}.
* Behave like netbuf_read_init() if ${ssl} is NULL. If the SSL context
* ${ssl} is not NULL, use it and ignore ${s}.
*/
struct netbuf_read *
netbuf_read_init2(int s, struct network_ssl_ctx * ssl)
Expand Down
8 changes: 4 additions & 4 deletions libcperciva/netbuf/netbuf_ssl_internal.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ extern void (* netbuf_write_ssl_cancel_func)(void *);

/**
* netbuf_read_init2(s, ssl):
* Behave like netbuf_read_init if ${ssl} is NULL. If the SSL context ${ssl}
* is not NULL, use it and ignore ${s}.
* Behave like netbuf_read_init() if ${ssl} is NULL. If the SSL context
* ${ssl} is not NULL, use it and ignore ${s}.
*/
struct netbuf_read * netbuf_read_init2(int, struct network_ssl_ctx *);

/**
* netbuf_write_init2(s, ssl, fail_callback, fail_cookie):
* Behave like netbuf_write_init if ${ssl} is NULL. If the SSL context ${ssl}
* is not NULL, use it and ignore ${s}.
* Behave like netbuf_write_init() if ${ssl} is NULL. If the SSL context
* ${ssl} is not NULL, use it and ignore ${s}.
*/
struct netbuf_write * netbuf_write_init2(int, struct network_ssl_ctx *,
int (*)(void *), void *);
Expand Down

0 comments on commit 5a859b1

Please sign in to comment.