* [dpdk-dev] [PATCH] doc: link doxygen docs to source code
@ 2015-04-22 16:10 John McNamara
2015-04-22 16:13 ` Mcnamara, John
2015-04-22 16:16 ` Butler, Siobhan A
0 siblings, 2 replies; 4+ messages in thread
From: John McNamara @ 2015-04-22 16:10 UTC (permalink / raw)
To: dev
Enabled Doxygen option to add links to the source code
in documented entities.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
doc/api/doxy-api.conf | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index da03e9b..c445f80 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -77,3 +77,4 @@ ALPHABETICAL_INDEX = NO
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
SEARCHENGINE = NO
+SOURCE_BROWSER = YES
--
1.8.1.4
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: link doxygen docs to source code
2015-04-22 16:10 [dpdk-dev] [PATCH] doc: link doxygen docs to source code John McNamara
@ 2015-04-22 16:13 ` Mcnamara, John
2015-04-22 16:16 ` Butler, Siobhan A
1 sibling, 0 replies; 4+ messages in thread
From: Mcnamara, John @ 2015-04-22 16:13 UTC (permalink / raw)
To: dev
> -----Original Message-----
> From: Mcnamara, John
> Sent: Wednesday, April 22, 2015 5:10 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John
> Subject: [PATCH] doc: link doxygen docs to source code
>
> Enabled Doxygen option to add links to the source code in documented
> entities.
Hi,
This patch is in response to a request from one of our customer facing engineers.
It enabled the Doxygen option to generate Html versions of the source/header files and links them to the documentation.
John.
--
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: link doxygen docs to source code
2015-04-22 16:10 [dpdk-dev] [PATCH] doc: link doxygen docs to source code John McNamara
2015-04-22 16:13 ` Mcnamara, John
@ 2015-04-22 16:16 ` Butler, Siobhan A
2015-04-29 16:36 ` Thomas Monjalon
1 sibling, 1 reply; 4+ messages in thread
From: Butler, Siobhan A @ 2015-04-22 16:16 UTC (permalink / raw)
To: Mcnamara, John, dev
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Wednesday, April 22, 2015 5:10 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: link doxygen docs to source code
>
> Enabled Doxygen option to add links to the source code in documented
> entities.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
> doc/api/doxy-api.conf | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf index
> da03e9b..c445f80 100644
> --- a/doc/api/doxy-api.conf
> +++ b/doc/api/doxy-api.conf
> @@ -77,3 +77,4 @@ ALPHABETICAL_INDEX = NO
> HTML_TIMESTAMP = NO
> HTML_DYNAMIC_SECTIONS = YES
> SEARCHENGINE = NO
> +SOURCE_BROWSER = YES
> --
> 1.8.1.4
Thanks John, I think this will help.
Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: link doxygen docs to source code
2015-04-22 16:16 ` Butler, Siobhan A
@ 2015-04-29 16:36 ` Thomas Monjalon
0 siblings, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2015-04-29 16:36 UTC (permalink / raw)
To: Mcnamara, John; +Cc: dev
> > Enabled Doxygen option to add links to the source code in documented
> > entities.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
>
> Thanks John, I think this will help.
> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
Applied, thanks
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2015-04-29 16:43 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-04-22 16:10 [dpdk-dev] [PATCH] doc: link doxygen docs to source code John McNamara
2015-04-22 16:13 ` Mcnamara, John
2015-04-22 16:16 ` Butler, Siobhan A
2015-04-29 16:36 ` Thomas Monjalon
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).