[PATCH] doc: add scatter gather functions in doxygen

[PATCH] doc: add scatter gather functions in doxygen

[Thomas Monjalon]

Some functions are available only if
RTE_MBUF_SCATTER_GATHER and RTE_MBUF_REFCNT_ATOMIC are enabled.
So they must configured for doxygen parser.

Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
---
 doc/doxy-api.conf |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index 5d3e4ca..28a0f84 100644
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -46,7 +46,9 @@ INPUT                   = doc/doxy-api-index.md \
                           lib/librte_timer
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
-PREDEFINED              = __DOXYGEN__
+PREDEFINED              = __DOXYGEN__ \
+                          RTE_MBUF_SCATTER_GATHER \
+                          RTE_MBUF_REFCNT_ATOMIC
 
 OPTIMIZE_OUTPUT_FOR_C   = YES
 EXTRACT_STATIC          = YES
-- 
1.7.10.4

[PATCH v2] doc: add mbuf cloning functions in doxygen

[Thomas Monjalon]

Some functions are available only if RTE_MBUF_SCATTER_GATHER is enabled.
So it must be configured for doxygen parser.

Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
---
 doc/doxy-api.conf |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index 5d3e4ca..7ea692a 100644
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -46,7 +46,8 @@ INPUT                   = doc/doxy-api-index.md \
                           lib/librte_timer
 FILE_PATTERNS           = rte_*.h \
                           cmdline.h
-PREDEFINED              = __DOXYGEN__
+PREDEFINED              = __DOXYGEN__ \
+                          RTE_MBUF_SCATTER_GATHER
 
 OPTIMIZE_OUTPUT_FOR_C   = YES
 EXTRACT_STATIC          = YES
-- 
1.7.10.4

Re: [PATCH v2] doc: add mbuf cloning functions in doxygen

[Olivier MATZ]

Hi,

> Some functions are available only if RTE_MBUF_SCATTER_GATHER is enabled.
> So it must be configured for doxygen parser.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>

Acked-by: Olivier Matz <olivier.matz-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>

Re: [PATCH v2] doc: add mbuf cloning functions in doxygen

[Thomas Monjalon]

> > Some functions are available only if RTE_MBUF_SCATTER_GATHER is enabled.
> > So it must be configured for doxygen parser.
> > 
> > Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
> 
> Acked-by: Olivier Matz <olivier.matz-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>

pushed

-- 
Thomas