Skip to content

doc from doxygen

Thomas Monjalon dpdk-dev 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 2 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4lib: fix some doxygen commentslib/librte_eal/common/include/rte_debug.h lib/librte_eal/common/include/rte_pci.h lib/librte_eal/common/include/rte_string_fns.h +1 more+8 -80 replies
2/4mk: factorize some rulesmk/rte.sdkroot.mk+18 -500 replies
3/4mk: clean dead doc rulesmk/rte.doc.mk mk/rte.sdkdoc.mk mk/rte.sdkroot.mk+4 -1650 replies
4/4doc: generate HTML for API with doxygendoc/doxy-api-index.md doc/doxy-api.conf doc/doxy-html-custom.sh +2 more+193 -70 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/4] doc from doxygen

These patches aims to generate a documentation for API from doxygen.

Thomas Monjalon (4):
lib: fix some doxygen comments
mk: factorize some rules
mk: clean dead doc rules
doc: generate HTML for API with doxygen

 doc/doxy-api-index.md                          |  101 +++++++++++++++++++
 doc/doxy-api.conf                              |   59 +++++++++++
 doc/doxy-html-custom.sh                        |    6 ++
 lib/librte_eal/common/include/rte_debug.h      |    2 +-
 lib/librte_eal/common/include/rte_pci.h        |    4 +-
 lib/librte_eal/common/include/rte_string_fns.h |    4 +-
 lib/librte_ether/rte_ethdev.h                  |    6 +-
 mk/rte.doc.mk                                  |  127 ------------------------
 mk/rte.sdkdoc.mk                               |   52 ++++------
 mk/rte.sdkroot.mk                              |   72 ++++----------
 10 files changed, 213 insertions(+), 220 deletions(-)
 create mode 100644 doc/doxy-api-index.md
 create mode 100644 doc/doxy-api.conf
 create mode 100755 doc/doxy-html-custom.sh
 delete mode 100644 mk/rte.doc.mk