diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2015-04-20 15:55:34 -0400 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-04-23 13:14:41 +0300 |
| commit | 82696daa907e71038a508446401daaacd83189dd (patch) | |
| tree | 591b1c4beb0643fa360bef57b10a6870e1c37cc1 /doc | |
| parent | d88e5e8953a43592d8c3fcb766810454abd9e55d (diff) | |
example: doxygen: remove examples from src path
If the examples are on the src path they pollute the documentation
with their own declarations.
The correct mechanism is to declare the examples to be seen in the
documentation in one location that is on the .dox path, and have the
EXAMPLE_PATH locate the actual example code.
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Anders Roxell <anders.roxell@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen.cfg | 7 | ||||
| -rw-r--r-- | doc/examples.dox | 20 |
2 files changed, 26 insertions, 1 deletions
diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index 4208afaeb..628338789 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -10,7 +10,12 @@ TYPEDEF_HIDES_STRUCT = NO EXTRACT_STATIC = YES SORT_MEMBER_DOCS = NO WARN_NO_PARAMDOC = YES -INPUT = $(SRCDIR)/doc $(SRCDIR)/doc/users-guide $(SRCDIR)/include $(SRCDIR)/platform/linux-generic/include/odp $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp $(SRCDIR)/helper/include $(SRCDIR)/example/packet $(SRCDIR)/example/generator $(SRCDIR)/example/timer +INPUT = $(SRCDIR)/doc \ + $(SRCDIR)/doc/users-guide \ + $(SRCDIR)/include \ + $(SRCDIR)/platform/linux-generic/include/odp \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ + $(SRCDIR)/helper/include FILE_PATTERNS = *.h odp*.c *.dox RECURSIVE = YES SOURCE_BROWSER = YES diff --git a/doc/examples.dox b/doc/examples.dox new file mode 100644 index 000000000..2a7c597c5 --- /dev/null +++ b/doc/examples.dox @@ -0,0 +1,20 @@ +/* Copyright (c) 2015, Linaro Limited + * All rights reserved. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** + * @example odp_generator.c + * ODP loopback demo application + */ + +/** + *@example odp_pktio.c + * ODP basic packet IO loopback test application + */ + +/** + * @example odp_timer_test.c + * ODP timer example application + */ |