From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH] doc: add example programs to doxygen api docs
Date: Fri, 11 Dec 2015 14:44:59 +0100
Message-ID: <1589699.YrWuBkibJg@xps13>
References: <1449841311-5372-1-git-send-email-john.mcnamara@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org
To: John McNamara <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wm0-f47.google.com (mail-wm0-f47.google.com [74.125.82.47])
 by dpdk.org (Postfix) with ESMTP id 0783A8E7B
 for <dev@dpdk.org>; Fri, 11 Dec 2015 14:46:17 +0100 (CET)
Received: by wmec201 with SMTP id c201so70759887wme.1
 for <dev@dpdk.org>; Fri, 11 Dec 2015 05:46:16 -0800 (PST)
In-Reply-To: <1449841311-5372-1-git-send-email-john.mcnamara@intel.com>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2015-12-11 13:41, John McNamara:
> Enable Doxygen parsing of DPDK example files so that the example
> code is linked to and from the API docs. This allows the reader
> to see examples of API usage in context by following a link.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Note sure of the benefit.
I think it would make more sense if an example was linked from the
related API, e.g. l3fwd-acl from rte_acl.h.