doxygen: update comments (#360)

baresip · May 14, 2022 · dff3f96 · dff3f96
1 parent e1b4a80
commit dff3f96
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 10 deletions.
diff --git a/mk/Doxyfile b/mk/Doxyfile
@@ -115,7 +115,7 @@ VERBATIM_HEADERS       = YES
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = YES
-COLS_IN_ALPHA_INDEX    = 5
+#COLS_IN_ALPHA_INDEX    = 5
 IGNORE_PREFIX          = 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
@@ -145,7 +145,7 @@ LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 COMPACT_LATEX          = NO
-PAPER_TYPE             = a4wide
+#PAPER_TYPE             = a4wide
 EXTRA_PACKAGES         = 
 LATEX_HEADER           = 
 PDF_HYPERLINKS         = NO
@@ -204,11 +204,11 @@ TAGFILES               =
 GENERATE_TAGFILE       = 
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
-PERL_PATH              = /usr/bin/perl
+#PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool   
 #---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = YES
+#CLASS_DIAGRAMS         = YES
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
 CLASS_GRAPH            = YES

diff --git a/src/sa/sa.c b/src/sa/sa.c
@@ -180,8 +180,6 @@ int sa_set_str(struct sa *sa, const char *addr, uint16_t port)
  * @param sa   Socket Address
  * @param addr IPv4 address in host order
  * @param port Port number
- *
- * @return 0 if success, otherwise errorcode
  */
 void sa_set_in(struct sa *sa, uint32_t addr, uint16_t port)
 {
@@ -202,8 +200,6 @@ void sa_set_in(struct sa *sa, uint32_t addr, uint16_t port)
  * @param sa   Socket Address
  * @param addr IPv6 address
  * @param port Port number
- *
- * @return 0 if success, otherwise errorcode
  */
 void sa_set_in6(struct sa *sa, const uint8_t *addr, uint16_t port)
 {

diff --git a/src/sipsess/sess.c b/src/sipsess/sess.c
@@ -282,6 +282,7 @@ int sipsess_set_close_headers(struct sipsess *sess, const char *hdrs, ...)
 /**
  * Send BYE and terminate session (useful when ACK has not been received)
  *
+ * @param sess      SIP Session
  */
 void sipsess_abort(struct sipsess *sess)
 {

diff --git a/src/stun/keepalive.c b/src/stun/keepalive.c
@@ -232,8 +232,6 @@ int stun_keepalive_alloc(struct stun_keepalive **skap,
  *
  * @param ska      Keepalive object
  * @param interval Interval in seconds (0 to disable)
- *
- * @return 0 if success, otherwise errorcode
  */
 void stun_keepalive_enable(struct stun_keepalive *ska, uint32_t interval)
 {

diff --git a/src/tls/openssl/tls.c b/src/tls/openssl/tls.c
@@ -1452,6 +1452,8 @@ void tls_disable_verify_server(struct tls *tls)
  *
  * @param tls     TLS Object
  * @param version Minimum version, e.g.: TLS1_2_VERSION
+ *
+ * @return 0 if success, otherwise errorcode
  */
 int tls_set_min_proto_version(struct tls *tls, int version)
 {
@@ -1474,6 +1476,8 @@ int tls_set_min_proto_version(struct tls *tls, int version)
  *
  * @param tls     TLS Object
  * @param version Maximum version, e.g. TLS1_2_VERSION
+ *
+ * @return 0 if success, otherwise errorcode
  */
 int tls_set_max_proto_version(struct tls *tls, int version)
 {
-Original file line number
+Diff line change
@@ Expand Up @@
     /**
      * Send BYE and terminate session (useful when ACK has not been received)
      *
+     * @param sess      SIP Session
      */
     void sipsess_abort(struct sipsess *sess)
     {
@@ Expand Down @@