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. In tightening up the definitions, there may be subtle changes in meaning which should be checked for carefully by reviewers. Where there was ambiguity, the behaviour of existing code is documented so as to avoid breaking existing apps. V3: * major cleanup following review by Mattias and on-list discussions * old patch 7 split in two and merged with other changes in the same area rather than being standalone. * new patch 11 added at end of series. 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: improve doxygen comments on config fns eventdev: improve doxygen comments for control APIs eventdev: improve comments on scheduling types eventdev: clarify docs on event object fields and op types eventdev: drop comment for anon union from doxygen lib/eventdev/rte_eventdev.h | 952 +++++++++++++++++++++++------------- 1 file changed, 620 insertions(+), 332 deletions(-) -- 2.40.1
