From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f51.google.com (mail-wm0-f51.google.com [74.125.82.51]) by dpdk.org (Postfix) with ESMTP id 32B3237A6 for ; Sun, 13 Dec 2015 23:05:09 +0100 (CET) Received: by mail-wm0-f51.google.com with SMTP id n186so95166769wmn.1 for ; Sun, 13 Dec 2015 14:05:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:organization:user-agent :in-reply-to:references:mime-version:content-transfer-encoding :content-type; bh=e8Ng3qsnUm2E2aLPDVMrsK7GsT6oOrslTIlyKO6iF1g=; b=N6d0x9/Lz1z2gLIwgzFcIw8f/0BVd8nGVabMWcfQgQV5pVow2XVgW6zoouLcbLC9VX Jbhhy+nn9Ja0PvWiAI9VEtcf3OcsqRmGMtxyBrLEZk7CyStjU1Ju0FYCgNwALfE+wLfR goyn0FsxKM3mFMEcIqik/3cWE4JSzeE/2ELJ7ibyUS81ffynYd6J3yAFWZJgdn1cKoPe Mt9akc+83BrI9HIKMDuBIDC/PA1hFdfEe8BGfsJ1jAkxNp/kiC92hnVf1aCVH4mCDbla 1GhTvWawsVV9H8jZN8Mwc8b37YModMZeuuHppCdkQfL4CS3RfxCdzVzaR0pj7N0GyLV0 jZww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:organization :user-agent:in-reply-to:references:mime-version :content-transfer-encoding:content-type; bh=e8Ng3qsnUm2E2aLPDVMrsK7GsT6oOrslTIlyKO6iF1g=; b=NFAbi8l4z7ipaiA/TMeJghz5w1ce+G9nKTbQWuK5C+QrpjCv7Sfoojn9AXLOUY8pU8 Xr3P523RCeolNCT24Pu7Bqc4b/6Wo+Nuxy4iEh7YEU+VRw86FS7GfKxR3Vdr+8Q0q/0P U7VdoGiPwY5rr5PKtK7nnKQ6PKnr5irLxWDOqQwsdwQxjlCtC8dIun09qO4jxfQTPiUQ rgRWPFep5EveCtKo5n/4yUwUBS9kqsiesE8njdtbbRSoYjck8pDhoJpcTpGQnrdbTPNR 1t98WxRXnehq4EoyLR1NzdpyVz0tU3y4nvIZImhkyDdnA9iWvuGLes7Fu5+CCQXBQX95 +yrQ== X-Gm-Message-State: ALoCoQmcdjZ3IbmKMhqx9wONehDcG/RnP9MDldzfAaALN1CHlgGro2YggfSXDNLpAiM+6d06MuxLW7+Gi0j37XfWJGl66rvEvA== X-Received: by 10.28.129.82 with SMTP id c79mr20934451wmd.80.1450044308988; Sun, 13 Dec 2015 14:05:08 -0800 (PST) Received: from xps13.localnet (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by smtp.gmail.com with ESMTPSA id l128sm13281462wmf.10.2015.12.13.14.05.07 (version=TLSv1/SSLv3 cipher=OTHER); Sun, 13 Dec 2015 14:05:07 -0800 (PST) From: Thomas Monjalon To: "Mcnamara, John" Date: Sun, 13 Dec 2015 23:03:52 +0100 Message-ID: <1763729.9jqLOAaaJI@xps13> Organization: 6WIND User-Agent: KMail/4.14.10 (Linux/4.1.6-1-ARCH; KDE/4.14.11; x86_64; ; ) In-Reply-To: References: <1449841311-5372-1-git-send-email-john.mcnamara@intel.com> <1589699.YrWuBkibJg@xps13> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH] doc: add example programs to doxygen api docs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 13 Dec 2015 22:05:09 -0000 2015-12-11 14:31, Mcnamara, John: > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] > > 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 > > > > 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. > > Hi, > > That is more or less the way it works. The links are bidirectional header/api <-> example. > > Have a look at the rte_acl.h html output after the patch is applied. Yes, it's nice. Applied with minor changes, thanks