diff mbox

[v2] dox:application: add examples to guide

Message ID 1469187673-26100-1-git-send-email-mike.holmes@linaro.org
State New
Headers show

Commit Message

Mike Holmes July 22, 2016, 11:41 a.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

---
v2
  alphabetical order (Maxim)

 doc/application-api-guide/examples.dox | 37 +++++++++++++++++++++++++++++++---
 1 file changed, 34 insertions(+), 3 deletions(-)

-- 
2.7.4

Comments

Bill Fischofer July 27, 2016, 9:19 p.m. UTC | #1
On Fri, Jul 22, 2016 at 6:41 AM, Mike Holmes <mike.holmes@linaro.org> wrote:

> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>


Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>


> ---

> v2

>   alphabetical order (Maxim)

>

>  doc/application-api-guide/examples.dox | 37

> +++++++++++++++++++++++++++++++---

>  1 file changed, 34 insertions(+), 3 deletions(-)

>

> diff --git a/doc/application-api-guide/examples.dox

> b/doc/application-api-guide/examples.dox

> index 2dccd7f..9838aec 100644

> --- a/doc/application-api-guide/examples.dox

> +++ b/doc/application-api-guide/examples.dox

> @@ -5,21 +5,52 @@

>   */

>

>  /**

> + * @example odp_classifier.c

> + * ODP classifier example application

> + */

> +

> +/**

>   * @example odp_generator.c

>   * ODP loopback demo application

>   */

>

>  /**

> + * @example odp_hello.c

> + * ODP Hello World  example application

> + */

> +

> +/**

> + * @example odp_ipsec.c

> + * ODP ipsec example application

> + */

> +

> +/**

> + * @example odp_l2fwd_simple.c

> + * ODP L2 forward  example application

> + */

> +

> +/**

>   *@example odp_pktio.c

>   * ODP basic packet IO loopback test application

>   */

>

>  /**

> + * @example odp_switch.c

> + * ODP switch example application

> + */

> +

> +/**

> + * @example odp_timer_simple.c

> + * ODP timer example application

> + */

> +

> +/**

>   * @example odp_timer_test.c

>   * ODP timer example application

>   */

> -

> +

>  /**

> - * @example odp_classifier.c

> - * ODP classifier example application

> + * @example odp_traffic_mgmt.c

> + * ODP Traffic Manager  example application

>   */

> +

> \ No newline at end of file

>


Not sure why this is here.  The patch seems to apply for me.


> --

> 2.7.4

>

>
Maxim Uvarov July 29, 2016, 4:13 p.m. UTC | #2
almost each line has white space on empty line:

ERROR: trailing whitespace
#23: FILE: doc/application-api-guide/examples.dox:11:
+ $

ERROR: trailing whitespace
#38: FILE: doc/application-api-guide/examples.dox:26:
+  $

ERROR: trailing whitespace
#43: FILE: doc/application-api-guide/examples.dox:31:
+ $

ERROR: trailing whitespace
#53: FILE: doc/application-api-guide/examples.dox:41:
+ $

ERROR: trailing whitespace
#64: FILE: doc/application-api-guide/examples.dox:51:
+ $

ERROR: trailing whitespace
#71: FILE: doc/application-api-guide/examples.dox:56:
+ $



On 07/28/16 00:19, Bill Fischofer wrote:
> On Fri, Jul 22, 2016 at 6:41 AM, Mike Holmes <mike.holmes@linaro.org> wrote:

>

>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>>

> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>

>

>

>> ---

>> v2

>>    alphabetical order (Maxim)

>>

>>   doc/application-api-guide/examples.dox | 37

>> +++++++++++++++++++++++++++++++---

>>   1 file changed, 34 insertions(+), 3 deletions(-)

>>

>> diff --git a/doc/application-api-guide/examples.dox

>> b/doc/application-api-guide/examples.dox

>> index 2dccd7f..9838aec 100644

>> --- a/doc/application-api-guide/examples.dox

>> +++ b/doc/application-api-guide/examples.dox

>> @@ -5,21 +5,52 @@

>>    */

>>

>>   /**

>> + * @example odp_classifier.c

>> + * ODP classifier example application

>> + */

>> +

>> +/**

>>    * @example odp_generator.c

>>    * ODP loopback demo application

>>    */

>>

>>   /**

>> + * @example odp_hello.c

>> + * ODP Hello World  example application

>> + */

>> +

>> +/**

>> + * @example odp_ipsec.c

>> + * ODP ipsec example application

>> + */

>> +

>> +/**

>> + * @example odp_l2fwd_simple.c

>> + * ODP L2 forward  example application

>> + */

>> +

>> +/**

>>    *@example odp_pktio.c

>>    * ODP basic packet IO loopback test application

>>    */

>>

>>   /**

>> + * @example odp_switch.c

>> + * ODP switch example application

>> + */

>> +

>> +/**

>> + * @example odp_timer_simple.c

>> + * ODP timer example application

>> + */

>> +

>> +/**

>>    * @example odp_timer_test.c

>>    * ODP timer example application

>>    */

>> -

>> +

>>   /**

>> - * @example odp_classifier.c

>> - * ODP classifier example application

>> + * @example odp_traffic_mgmt.c

>> + * ODP Traffic Manager  example application

>>    */

>> +

>> \ No newline at end of file

>>

> Not sure why this is here.  The patch seems to apply for me.


>> --

>> 2.7.4

>>

>>
diff mbox

Patch

diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox
index 2dccd7f..9838aec 100644
--- a/doc/application-api-guide/examples.dox
+++ b/doc/application-api-guide/examples.dox
@@ -5,21 +5,52 @@ 
  */
 
 /**
+ * @example odp_classifier.c
+ * ODP classifier example application
+ */
+ 
+/**
  * @example odp_generator.c
  * ODP loopback demo application
  */
 
 /**
+ * @example odp_hello.c
+ * ODP Hello World  example application
+ */
+
+/**
+ * @example odp_ipsec.c
+ * ODP ipsec example application
+ */
+  
+/**
+ * @example odp_l2fwd_simple.c
+ * ODP L2 forward  example application
+ */
+ 
+/**
  *@example odp_pktio.c
  * ODP basic packet IO loopback test application
  */
 
 /**
+ * @example odp_switch.c
+ * ODP switch example application
+ */
+ 
+/**
+ * @example odp_timer_simple.c
+ * ODP timer example application
+ */
+
+/**
  * @example odp_timer_test.c
  * ODP timer example application
  */
-
+ 
 /**
- * @example odp_classifier.c
- * ODP classifier example application
+ * @example odp_traffic_mgmt.c
+ * ODP Traffic Manager  example application
  */
+ 
\ No newline at end of file