mbox series

[v1,0/7] improve eventdev API specification/documentation

Message ID 20240118134557.73172-1-bruce.richardson@intel.com (mailing list archive)
Headers
Series improve eventdev API specification/documentation |

Message

Bruce Richardson Jan. 18, 2024, 1:45 p.m. UTC 
  This patchset makes small rewording improvements to the eventdev doxygen
documentation to try and ensure that it is as clear as possible,
describes the implementation as accurately as possible, and is
consistent within itself. Most changes are just minor rewordings, along
with plenty of changes to change references into doxygen
links/cross-references.

For now I am approx 1/4 way through reviewing the rte_eventdev.h file,
but sending v1 now to get any reviews started.

Bruce Richardson (7):
  eventdev: improve doxygen introduction text
  eventdev: move text on driver internals to proper section
  eventdev: update documentation on device capability flags
  eventdev: cleanup doxygen comments on info structure
  eventdev: improve function documentation for query fns
  eventdev: improve doxygen comments on configure struct
  eventdev: fix documentation for counting single-link ports

 lib/eventdev/rte_eventdev.c |   2 +-
 lib/eventdev/rte_eventdev.h | 391 +++++++++++++++++++++++-------------
 2 files changed, 247 insertions(+), 146 deletions(-)

--
2.40.1