From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: add missing API headers
Date: Tue, 11 Aug 2015 18:29:57 +0200 [thread overview]
Message-ID: <1439310597-23870-1-git-send-email-thomas.monjalon@6wind.com> (raw)
Some libraries were not included in doxygen documentation.
Other ones were included but not listed in the index.
The malloc library is now included in EAL.
The libraries compat and jobstats are added but not doxygen compliant.
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
doc/api/doxy-api-index.md | 16 ++++++++++++++--
doc/api/doxy-api.conf | 4 +++-
2 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 6958f8f..72ac3c4 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -36,7 +36,9 @@ API {#index}
There are many libraries, so their headers may be grouped by topics:
- **device**:
+ [dev] (@ref rte_dev.h),
[ethdev] (@ref rte_ethdev.h),
+ [ethctrl] (@ref rte_eth_ctrl.h),
[devargs] (@ref rte_devargs.h),
[bond] (@ref rte_eth_bond.h),
[vhost] (@ref rte_virtio_net.h),
@@ -76,12 +78,15 @@ There are many libraries, so their headers may be grouped by topics:
- **layers**:
[ethernet] (@ref rte_ether.h),
+ [ARP] (@ref rte_arp.h),
+ [ICMP] (@ref rte_icmp.h),
[IP] (@ref rte_ip.h),
[SCTP] (@ref rte_sctp.h),
[TCP] (@ref rte_tcp.h),
[UDP] (@ref rte_udp.h),
[frag/reass] (@ref rte_ip_frag.h),
- [LPM route] (@ref rte_lpm.h),
+ [LPM IPv4 route] (@ref rte_lpm.h),
+ [LPM IPv6 route] (@ref rte_lpm6.h),
[ACL] (@ref rte_acl.h)
- **QoS**:
@@ -92,6 +97,7 @@ There are many libraries, so their headers may be grouped by topics:
- **hashes**:
[hash] (@ref rte_hash.h),
[jhash] (@ref rte_jhash.h),
+ [thash] (@ref rte_thash.h),
[FBK hash] (@ref rte_fbk_hash.h),
[CRC hash] (@ref rte_hash_crc.h)
@@ -99,8 +105,10 @@ There are many libraries, so their headers may be grouped by topics:
[mbuf] (@ref rte_mbuf.h),
[ring] (@ref rte_ring.h),
[distributor] (@ref rte_distributor.h),
+ [reorder] (@ref rte_reorder.h),
[tailq] (@ref rte_tailq.h),
- [bitmap] (@ref rte_bitmap.h)
+ [bitmap] (@ref rte_bitmap.h),
+ [ivshmem] (@ref rte_ivshmem.h)
- **packet framework**:
* [port] (@ref rte_port.h):
@@ -122,10 +130,13 @@ There are many libraries, so their headers may be grouped by topics:
- **basic**:
[approx fraction] (@ref rte_approx.h),
[random] (@ref rte_random.h),
+ [config file] (@ref rte_cfgfile.h),
[key/value args] (@ref rte_kvargs.h),
[string] (@ref rte_string_fns.h)
- **debug**:
+ [jobstats] (@ref rte_jobstats.h),
+ [hexdump] (@ref rte_hexdump.h),
[debug] (@ref rte_debug.h),
[log] (@ref rte_log.h),
[warnings] (@ref rte_warnings.h),
@@ -134,4 +145,5 @@ There are many libraries, so their headers may be grouped by topics:
- **misc**:
[EAL config] (@ref rte_eal.h),
[common] (@ref rte_common.h),
+ [ABI compat] (@ref rte_compat.h),
[version] (@ref rte_version.h)
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index de32af1..cfb4627 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -34,16 +34,18 @@ INPUT = doc/api/doxy-api-index.md \
lib/librte_eal/common/include \
lib/librte_eal/common/include/generic \
lib/librte_acl \
+ lib/librte_cfgfile \
lib/librte_cmdline \
+ lib/librte_compat \
lib/librte_distributor \
lib/librte_ether \
lib/librte_hash \
lib/librte_ip_frag \
+ lib/librte_ivshmem \
lib/librte_jobstats \
lib/librte_kni \
lib/librte_kvargs \
lib/librte_lpm \
- lib/librte_malloc \
lib/librte_mbuf \
lib/librte_mempool \
lib/librte_meter \
--
2.4.2
next reply other threads:[~2015-08-11 16:31 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-11 16:29 Thomas Monjalon [this message]
2015-08-11 18:03 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1439310597-23870-1-git-send-email-thomas.monjalon@6wind.com \
--to=thomas.monjalon@6wind.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).