[dpdk-dev] [PATCH] doc: fix doxygen errors with v1.15.0

[dpdk-dev] [PATCH] doc: fix doxygen errors with v1.15.0

[jerinj]

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(-)

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,
-- 
2.51.2

Re: [dpdk-dev] [PATCH] doc: fix doxygen errors with v1.15.0

[Stephen Hemminger]

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>

Re: [dpdk-dev] [PATCH] doc: fix doxygen errors with v1.15.0

[Carrillo, Erik G]

[-- Attachment #1: Type: text/plain, Size: 1073 bytes --]

Thanks, Jerin.

________________________________
From: jerinj@marvell.com <jerinj@marvell.com>
Sent: Tuesday, October 28, 2025 9:11 AM
To: Carrillo, Erik G <erik.g.carrillo@intel.com>; Jerin Jacob <jerinj@marvell.com>; Sachin Saxena <sachin.saxena@nxp.com>; Hemant Agrawal <hemant.agrawal@nxp.com>; Pavan Nikhilesh <pbhagavatula@marvell.com>
Cc: dev@dpdk.org <dev@dpdk.org>; thomas@monjalon.net <thomas@monjalon.net>; Marchand, David <david.marchand@redhat.com>; stable@dpdk.org <stable@dpdk.org>
Subject: [dpdk-dev] [PATCH] doc: fix doxygen errors with v1.15.0

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>
---
Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>



[-- Attachment #2: Type: text/html, Size: 2372 bytes --]