This patchset makes 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. However, the final two patches are attempting to clarify what, to me anyway, is unclear wording in some key definitions. As such, it probably requires careful review by eventdev PMD maintainers, as different implementaters may have different understandings of what the text meant, and in some cases in "clarifying" I may have changed the meaning in a way that breaks things. V2: * additional cleanup and changes * remove "escaped" accidental change to .c file Bruce Richardson (11): 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 eventdev: improve doxygen comments on config fns eventdev: improve doxygen comments for control APIs eventdev: RFC clarify comments on scheduling types eventdev: RFC, clarify docs on event object fields lib/eventdev/rte_eventdev.h | 773 +++++++++++++++++++++++------------- 1 file changed, 501 insertions(+), 272 deletions(-) -- 2.40.1
