* [PATCH] lib: remove empty return types from doxygen comments
@ 2022-10-25 13:22 Ali Alnubani
2022-10-25 13:32 ` [PATCH v2] " Ali Alnubani
0 siblings, 1 reply; 4+ messages in thread
From: Ali Alnubani @ 2022-10-25 13:22 UTC (permalink / raw)
To: dev
Recent versions of doxygen (1.9.4 and newer) complain about
the None return types for functions that don't return anything.
Fixes the following build error:
[..]
Generating doc/api/doxygen with a custom command
FAILED: doc/api/html
/usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html
/usr/bin/doxygen doc/api/doxy-api.conf
/root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented
return type for rte_bitmap_prefetch0 that does not return anything
(warning treated as error, aborting now)
[..]
Tested with doxygen versions (1.9.1, 1.9.4, 1.8.17).
Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
---
lib/eal/include/rte_bitmap.h | 2 --
lib/eal/include/rte_hexdump.h | 4 ----
lib/fib/rte_fib.h | 2 --
lib/fib/rte_fib6.h | 2 --
lib/hash/rte_thash.h | 2 --
lib/ipsec/rte_ipsec_sad.h | 2 --
lib/lpm/rte_lpm.h | 2 --
lib/lpm/rte_lpm6.h | 2 --
lib/reorder/rte_reorder.h | 2 --
lib/rib/rte_rib.h | 2 --
lib/rib/rte_rib6.h | 2 --
11 files changed, 24 deletions(-)
diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
index e4623bb176..c589d5cde0 100644
--- a/lib/eal/include/rte_bitmap.h
+++ b/lib/eal/include/rte_bitmap.h
@@ -327,8 +327,6 @@ rte_bitmap_reset(struct rte_bitmap *bmp)
* Handle to bitmap instance
* @param pos
* Bit position
- * @return
- * 0 upon success, error code otherwise
*/
static inline void
rte_bitmap_prefetch0(struct rte_bitmap *bmp, uint32_t pos)
diff --git a/lib/eal/include/rte_hexdump.h b/lib/eal/include/rte_hexdump.h
index 2d03c089c4..80cf2933a7 100644
--- a/lib/eal/include/rte_hexdump.h
+++ b/lib/eal/include/rte_hexdump.h
@@ -27,8 +27,6 @@ extern "C" {
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
extern void
@@ -45,8 +43,6 @@ rte_hexdump(FILE *f, const char * title, const void * buf, unsigned int len);
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
void
diff --git a/lib/fib/rte_fib.h b/lib/fib/rte_fib.h
index baa206093c..d7a5aafe53 100644
--- a/lib/fib/rte_fib.h
+++ b/lib/fib/rte_fib.h
@@ -124,8 +124,6 @@ rte_fib_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib_free(struct rte_fib *fib);
diff --git a/lib/fib/rte_fib6.h b/lib/fib/rte_fib6.h
index 6fc915b1f3..2eb8b82676 100644
--- a/lib/fib/rte_fib6.h
+++ b/lib/fib/rte_fib6.h
@@ -115,8 +115,6 @@ rte_fib6_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib6_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib6_free(struct rte_fib6 *fib);
diff --git a/lib/hash/rte_thash.h b/lib/hash/rte_thash.h
index 451f64043a..c20ff0244c 100644
--- a/lib/hash/rte_thash.h
+++ b/lib/hash/rte_thash.h
@@ -329,8 +329,6 @@ rte_thash_find_existing(const char *name);
*
* @param ctx
* Thash context
- * @return
- * None
*/
__rte_experimental
void
diff --git a/lib/ipsec/rte_ipsec_sad.h b/lib/ipsec/rte_ipsec_sad.h
index a3ae57df7e..dbd89901af 100644
--- a/lib/ipsec/rte_ipsec_sad.h
+++ b/lib/ipsec/rte_ipsec_sad.h
@@ -139,8 +139,6 @@ rte_ipsec_sad_find_existing(const char *name);
*
* @param sad
* pointer to the SAD object
- * @return
- * None
*/
void
rte_ipsec_sad_destroy(struct rte_ipsec_sad *sad);
diff --git a/lib/lpm/rte_lpm.h b/lib/lpm/rte_lpm.h
index c8295905e4..82139c6447 100644
--- a/lib/lpm/rte_lpm.h
+++ b/lib/lpm/rte_lpm.h
@@ -180,8 +180,6 @@ rte_lpm_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm_free(struct rte_lpm *lpm);
diff --git a/lib/lpm/rte_lpm6.h b/lib/lpm/rte_lpm6.h
index cd9ce17989..c93683e624 100644
--- a/lib/lpm/rte_lpm6.h
+++ b/lib/lpm/rte_lpm6.h
@@ -73,8 +73,6 @@ rte_lpm6_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm6_free(struct rte_lpm6 *lpm);
diff --git a/lib/reorder/rte_reorder.h b/lib/reorder/rte_reorder.h
index f72f07e645..4f9f71af75 100644
--- a/lib/reorder/rte_reorder.h
+++ b/lib/reorder/rte_reorder.h
@@ -116,8 +116,6 @@ rte_reorder_reset(struct rte_reorder_buffer *b);
* @param b
* Pointer to reorder buffer instance.
* If b is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_reorder_free(struct rte_reorder_buffer *b);
diff --git a/lib/rib/rte_rib.h b/lib/rib/rte_rib.h
index f41774afe7..2054d3cebd 100644
--- a/lib/rib/rte_rib.h
+++ b/lib/rib/rte_rib.h
@@ -265,8 +265,6 @@ rte_rib_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib_free(struct rte_rib *rib);
diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h
index 49d5b99b70..775286f965 100644
--- a/lib/rib/rte_rib6.h
+++ b/lib/rib/rte_rib6.h
@@ -320,8 +320,6 @@ rte_rib6_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib6_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib6_free(struct rte_rib6 *rib);
--
2.25.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH v2] lib: remove empty return types from doxygen comments
2022-10-25 13:22 [PATCH] lib: remove empty return types from doxygen comments Ali Alnubani
@ 2022-10-25 13:32 ` Ali Alnubani
2022-10-25 16:00 ` Stephen Hemminger
0 siblings, 1 reply; 4+ messages in thread
From: Ali Alnubani @ 2022-10-25 13:32 UTC (permalink / raw)
To: dev
Recent versions of doxygen (1.9.4 and newer) complain about
documented return types for functions that don't return anything.
This patch removes these return types to fix build errors similar
to this one:
[..]
Generating doc/api/doxygen with a custom command
FAILED: doc/api/html
/usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html
/usr/bin/doxygen doc/api/doxy-api.conf
/root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented
return type for rte_bitmap_prefetch0 that does not return anything
(warning treated as error, aborting now)
[..]
Tested with doxygen versions: 1.8.13, 1.8.17, 1.9.1, and 1.9.4.
Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
---
Changes in v2:
- Reword commit message.
- Add 1.8.13 to list of tested doxygen versions.
lib/eal/include/rte_bitmap.h | 2 --
lib/eal/include/rte_hexdump.h | 4 ----
lib/fib/rte_fib.h | 2 --
lib/fib/rte_fib6.h | 2 --
lib/hash/rte_thash.h | 2 --
lib/ipsec/rte_ipsec_sad.h | 2 --
lib/lpm/rte_lpm.h | 2 --
lib/lpm/rte_lpm6.h | 2 --
lib/reorder/rte_reorder.h | 2 --
lib/rib/rte_rib.h | 2 --
lib/rib/rte_rib6.h | 2 --
11 files changed, 24 deletions(-)
diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
index e4623bb176..c589d5cde0 100644
--- a/lib/eal/include/rte_bitmap.h
+++ b/lib/eal/include/rte_bitmap.h
@@ -327,8 +327,6 @@ rte_bitmap_reset(struct rte_bitmap *bmp)
* Handle to bitmap instance
* @param pos
* Bit position
- * @return
- * 0 upon success, error code otherwise
*/
static inline void
rte_bitmap_prefetch0(struct rte_bitmap *bmp, uint32_t pos)
diff --git a/lib/eal/include/rte_hexdump.h b/lib/eal/include/rte_hexdump.h
index 2d03c089c4..80cf2933a7 100644
--- a/lib/eal/include/rte_hexdump.h
+++ b/lib/eal/include/rte_hexdump.h
@@ -27,8 +27,6 @@ extern "C" {
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
extern void
@@ -45,8 +43,6 @@ rte_hexdump(FILE *f, const char * title, const void * buf, unsigned int len);
* This is the buffer address to print out.
* @param len
* The number of bytes to dump out
-* @return
-* None.
*/
void
diff --git a/lib/fib/rte_fib.h b/lib/fib/rte_fib.h
index baa206093c..d7a5aafe53 100644
--- a/lib/fib/rte_fib.h
+++ b/lib/fib/rte_fib.h
@@ -124,8 +124,6 @@ rte_fib_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib_free(struct rte_fib *fib);
diff --git a/lib/fib/rte_fib6.h b/lib/fib/rte_fib6.h
index 6fc915b1f3..2eb8b82676 100644
--- a/lib/fib/rte_fib6.h
+++ b/lib/fib/rte_fib6.h
@@ -115,8 +115,6 @@ rte_fib6_find_existing(const char *name);
* @param fib
* FIB object handle created by rte_fib6_create().
* If fib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_fib6_free(struct rte_fib6 *fib);
diff --git a/lib/hash/rte_thash.h b/lib/hash/rte_thash.h
index 451f64043a..c20ff0244c 100644
--- a/lib/hash/rte_thash.h
+++ b/lib/hash/rte_thash.h
@@ -329,8 +329,6 @@ rte_thash_find_existing(const char *name);
*
* @param ctx
* Thash context
- * @return
- * None
*/
__rte_experimental
void
diff --git a/lib/ipsec/rte_ipsec_sad.h b/lib/ipsec/rte_ipsec_sad.h
index a3ae57df7e..dbd89901af 100644
--- a/lib/ipsec/rte_ipsec_sad.h
+++ b/lib/ipsec/rte_ipsec_sad.h
@@ -139,8 +139,6 @@ rte_ipsec_sad_find_existing(const char *name);
*
* @param sad
* pointer to the SAD object
- * @return
- * None
*/
void
rte_ipsec_sad_destroy(struct rte_ipsec_sad *sad);
diff --git a/lib/lpm/rte_lpm.h b/lib/lpm/rte_lpm.h
index c8295905e4..82139c6447 100644
--- a/lib/lpm/rte_lpm.h
+++ b/lib/lpm/rte_lpm.h
@@ -180,8 +180,6 @@ rte_lpm_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm_free(struct rte_lpm *lpm);
diff --git a/lib/lpm/rte_lpm6.h b/lib/lpm/rte_lpm6.h
index cd9ce17989..c93683e624 100644
--- a/lib/lpm/rte_lpm6.h
+++ b/lib/lpm/rte_lpm6.h
@@ -73,8 +73,6 @@ rte_lpm6_find_existing(const char *name);
* @param lpm
* LPM object handle
* If lpm is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_lpm6_free(struct rte_lpm6 *lpm);
diff --git a/lib/reorder/rte_reorder.h b/lib/reorder/rte_reorder.h
index f72f07e645..4f9f71af75 100644
--- a/lib/reorder/rte_reorder.h
+++ b/lib/reorder/rte_reorder.h
@@ -116,8 +116,6 @@ rte_reorder_reset(struct rte_reorder_buffer *b);
* @param b
* Pointer to reorder buffer instance.
* If b is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_reorder_free(struct rte_reorder_buffer *b);
diff --git a/lib/rib/rte_rib.h b/lib/rib/rte_rib.h
index f41774afe7..2054d3cebd 100644
--- a/lib/rib/rte_rib.h
+++ b/lib/rib/rte_rib.h
@@ -265,8 +265,6 @@ rte_rib_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib_free(struct rte_rib *rib);
diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h
index 49d5b99b70..775286f965 100644
--- a/lib/rib/rte_rib6.h
+++ b/lib/rib/rte_rib6.h
@@ -320,8 +320,6 @@ rte_rib6_find_existing(const char *name);
* @param rib
* RIB object handle created with rte_rib6_create().
* If rib is NULL, no operation is performed.
- * @return
- * None
*/
void
rte_rib6_free(struct rte_rib6 *rib);
--
2.25.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] lib: remove empty return types from doxygen comments
2022-10-25 13:32 ` [PATCH v2] " Ali Alnubani
@ 2022-10-25 16:00 ` Stephen Hemminger
2022-10-26 15:52 ` Thomas Monjalon
0 siblings, 1 reply; 4+ messages in thread
From: Stephen Hemminger @ 2022-10-25 16:00 UTC (permalink / raw)
To: Ali Alnubani; +Cc: dev
On Tue, 25 Oct 2022 16:32:38 +0300
Ali Alnubani <alialnu@nvidia.com> wrote:
> Recent versions of doxygen (1.9.4 and newer) complain about
> documented return types for functions that don't return anything.
>
> This patch removes these return types to fix build errors similar
> to this one:
> [..]
> Generating doc/api/doxygen with a custom command
> FAILED: doc/api/html
> /usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html
> /usr/bin/doxygen doc/api/doxy-api.conf
> /root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented
> return type for rte_bitmap_prefetch0 that does not return anything
> (warning treated as error, aborting now)
> [..]
>
> Tested with doxygen versions: 1.8.13, 1.8.17, 1.9.1, and 1.9.4.
>
> Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
Acked-by: Stephen Hemminger <stephen@networkplumber.org>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] lib: remove empty return types from doxygen comments
2022-10-25 16:00 ` Stephen Hemminger
@ 2022-10-26 15:52 ` Thomas Monjalon
0 siblings, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2022-10-26 15:52 UTC (permalink / raw)
To: Ali Alnubani; +Cc: dev, Stephen Hemminger
25/10/2022 18:00, Stephen Hemminger:
> On Tue, 25 Oct 2022 16:32:38 +0300
> Ali Alnubani <alialnu@nvidia.com> wrote:
>
> > Recent versions of doxygen (1.9.4 and newer) complain about
> > documented return types for functions that don't return anything.
> >
> > This patch removes these return types to fix build errors similar
> > to this one:
> > [..]
> > Generating doc/api/doxygen with a custom command
> > FAILED: doc/api/html
> > /usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html
> > /usr/bin/doxygen doc/api/doxy-api.conf
> > /root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented
> > return type for rte_bitmap_prefetch0 that does not return anything
> > (warning treated as error, aborting now)
> > [..]
> >
> > Tested with doxygen versions: 1.8.13, 1.8.17, 1.9.1, and 1.9.4.
> >
> > Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
>
> Acked-by: Stephen Hemminger <stephen@networkplumber.org>
Applied, thanks.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-10-26 15:52 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-10-25 13:22 [PATCH] lib: remove empty return types from doxygen comments Ali Alnubani
2022-10-25 13:32 ` [PATCH v2] " Ali Alnubani
2022-10-25 16:00 ` Stephen Hemminger
2022-10-26 15:52 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).