diff mbox series

doc: fix doxygen errors with v1.15.0

Message ID 20251028141159.177727-1-jerinj@marvell.com (mailing list archive)
State Accepted
Delegated to: Thomas Monjalon
Headers
Series doc: fix doxygen errors with v1.15.0 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Functional success Functional Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build fail github build: failed
ci/iol-sample-apps-testing warning Testing issues
ci/aws-unit-testing success Unit Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing warning Testing issues
ci/iol-unit-arm64-testing success Testing PASS

Commit Message

Jerin Jacob Oct. 28, 2025, 2:11 p.m. UTC 
From: Jerin Jacob <jerinj@marvell.com>

Doxygen detects valid errors. Fixing the same.

Example:
lib/eventdev/rte_event_timer_adapter.h:720: error: Reached end of file
while still searching closing '`' of a verbatim block starting at line
569 (warning treated as error, aborting now)

Fixes: a6562f6d6f8e ("eventdev: introduce event timer adapter")
Cc: stable@dpdk.org

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 lib/eventdev/rte_event_timer_adapter.h | 2 +-
 lib/rawdev/rte_rawdev_pmd.h            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Stephen Hemminger Oct. 28, 2025, 2:14 p.m. UTC | #1 
On Tue, 28 Oct 2025 19:41:59 +0530
<jerinj@marvell.com> wrote:

> Doxygen detects valid errors. Fixing the same.
> 
> Example:
> lib/eventdev/rte_event_timer_adapter.h:720: error: Reached end of file
> while still searching closing '`' of a verbatim block starting at line
> 569 (warning treated as error, aborting now)
> 
> Fixes: a6562f6d6f8e ("eventdev: introduce event timer adapter")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---

Acked-by: Stephen Hemminger <stephen@networkplumber.org>
Carrillo, Erik G Oct. 28, 2025, 2:47 p.m. UTC | #2 
Thanks, Jerin.
Thomas Monjalon Nov. 11, 2025, 6:43 p.m. UTC | #3 
> Doxygen detects valid errors. Fixing the same.
> 
> Example:
> lib/eventdev/rte_event_timer_adapter.h:720: error: Reached end of file
> while still searching closing '`' of a verbatim block starting at line
> 569 (warning treated as error, aborting now)
> 
> Fixes: a6562f6d6f8e ("eventdev: introduce event timer adapter")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/lib/eventdev/rte_event_timer_adapter.h b/lib/eventdev/rte_event_timer_adapter.h
index 256807b3bf..67e65ab849 100644
--- a/lib/eventdev/rte_event_timer_adapter.h
+++ b/lib/eventdev/rte_event_timer_adapter.h
@@ -566,7 +566,7 @@  struct __rte_cache_aligned rte_event_timer_adapter {
  * Before calling this function, the application allocates
  * ``struct rte_event_timer`` objects from mempool or huge page backed
  * application buffers of desired size. On successful allocation,
- * application updates the `struct rte_event_timer`` attributes such as
+ * application updates the ``struct rte_event_timer`` attributes such as
  * expiry event attributes, timeout ticks from now.
  * This function submits the event timer arm requests to the event timer adapter
  * and on expiry, the events will be injected to designated event queue.
diff --git a/lib/rawdev/rte_rawdev_pmd.h b/lib/rawdev/rte_rawdev_pmd.h
index b810006a46..02351a2a29 100644
--- a/lib/rawdev/rte_rawdev_pmd.h
+++ b/lib/rawdev/rte_rawdev_pmd.h
@@ -506,7 +506,7 @@  typedef int (*rawdev_firmware_version_get_t)(struct rte_rawdev *dev,
  *   >0, ~0: for successful load
  *   <0: for failure
  *
- * @see Application may use 'firmware_version_get` for ascertaining successful
+ * @see Application may use `firmware_version_get` for ascertaining successful
  * load
  */
 typedef int (*rawdev_firmware_load_t)(struct rte_rawdev *dev,