diff mbox

[dpdk-dev] doc: link doxygen docs to source code

Message ID 1429719002-3004-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

John McNamara April 22, 2015, 4:10 p.m. UTC 
  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(+)

Comments

John McNamara April 22, 2015, 4:13 p.m. UTC | #1 
> -----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.
--
Siobhan Butler April 22, 2015, 4:16 p.m. UTC | #2 
> -----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>
Thomas Monjalon April 29, 2015, 4:36 p.m. UTC | #3 
> > 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
diff mbox

Patch

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