| Message ID | 1469011773-31985-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | New |
| Headers | show |
On 07/20/16 13:49, Mike Holmes wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > doc/application-api-guide/examples.dox | 25 +++++++++++++++++++++++++ > 1 file changed, 25 insertions(+) > > diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox > index 2dccd7f..2398d15 100644 > --- a/doc/application-api-guide/examples.dox > +++ b/doc/application-api-guide/examples.dox > @@ -23,3 +23,28 @@ > * @example odp_classifier.c > * ODP classifier example application > */ > + > +/** > + * @example odp_traffic_mgmt.c > + * ODP Traffic Manager example application > + */ > + > +/** > + * @example odp_l2fwd_simple.c > + * ODP L2 forward example application > + */ > + > +/** > + * @example odp_hello.c > + * ODP Hello World example application > + */ > + > +/** > + * @example odp_switch.c > + * ODP switch example application > + */ > + > +/** > + * @example odp_timer_simple.c > + * ODP timer example application > + */ Should it be alphabetical order or you did not add original l2fwd app. Maxim.
The output is order independent when doxygen uses this, I don't see a big need for it to be ordered, but if it bothers you I will sort the existing list and make it part of this as well, no worries :) I do think we should have a file per example that contains a useful description, the current place holders are not that helpfull! Mike On 22 July 2016 at 06:52, Maxim Uvarov <maxim.uvarov@linaro.org> wrote: > On 07/20/16 13:49, Mike Holmes wrote: > >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >> --- >> doc/application-api-guide/examples.dox | 25 +++++++++++++++++++++++++ >> 1 file changed, 25 insertions(+) >> >> diff --git a/doc/application-api-guide/examples.dox >> b/doc/application-api-guide/examples.dox >> index 2dccd7f..2398d15 100644 >> --- a/doc/application-api-guide/examples.dox >> +++ b/doc/application-api-guide/examples.dox >> @@ -23,3 +23,28 @@ >> * @example odp_classifier.c >> * ODP classifier example application >> */ >> + >> +/** >> + * @example odp_traffic_mgmt.c >> + * ODP Traffic Manager example application >> + */ >> + >> +/** >> + * @example odp_l2fwd_simple.c >> + * ODP L2 forward example application >> + */ >> + >> +/** >> + * @example odp_hello.c >> + * ODP Hello World example application >> + */ >> + >> +/** >> + * @example odp_switch.c >> + * ODP switch example application >> + */ >> + >> +/** >> + * @example odp_timer_simple.c >> + * ODP timer example application >> + */ >> > Should it be alphabetical order or you did not add original l2fwd app. > > Maxim. > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs "Work should be fun and collaborative, the rest follows"
diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox index 2dccd7f..2398d15 100644 --- a/doc/application-api-guide/examples.dox +++ b/doc/application-api-guide/examples.dox @@ -23,3 +23,28 @@ * @example odp_classifier.c * ODP classifier example application */ + +/** + * @example odp_traffic_mgmt.c + * ODP Traffic Manager example application + */ + +/** + * @example odp_l2fwd_simple.c + * ODP L2 forward example application + */ + +/** + * @example odp_hello.c + * ODP Hello World example application + */ + +/** + * @example odp_switch.c + * ODP switch example application + */ + +/** + * @example odp_timer_simple.c + * ODP timer example application + */
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/application-api-guide/examples.dox | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) -- 2.7.4