Signed-off-by: Mike Holmes <mike.hol...@linaro.org> --- configure.ac | 6 +++++- doc/Makefile.am | 2 +- doc/helper-guide/.gitignore | 1 + doc/helper-guide/Doxyfile | 45 ++++++++++++++++++++++++++++++++++++++++++++ doc/helper-guide/Makefile.am | 6 ++++++ doc/helper-guide/odp.dox | 26 +++++++++++++++++++++++++ doc/m4/configure.m4 | 1 + 7 files changed, 85 insertions(+), 2 deletions(-) create mode 100644 doc/helper-guide/.gitignore create mode 100644 doc/helper-guide/Doxyfile create mode 100644 doc/helper-guide/Makefile.am create mode 100644 doc/helper-guide/odp.dox
diff --git a/configure.ac b/configure.ac index 8ca95c1..88abe16 100644 --- a/configure.ac +++ b/configure.ac @@ -153,7 +153,11 @@ AM_CONDITIONAL([HAVE_MSCGEN], [test "x${MSCGEN}" = "xmscgen"]) DX_HTML_FEATURE(ON) DX_PDF_FEATURE(OFF) DX_PS_FEATURE(OFF) -DX_INIT_DOXYGEN($PACKAGE_NAME, ${srcdir}/doc/application-api-guide/Doxyfile, ${builddir}/doc/application-api-guide/output) +DX_INIT_DOXYGEN($PACKAGE_NAME, + ${srcdir}/doc/application-api-guide/Doxyfile, + ${builddir}/doc/application-api-guide/output, + ${srcdir}/doc/helper-guide/Doxyfile, + ${builddir}/doc/helper-guide/output) ########################################################################## # Enable/disable ODP_DEBUG_PRINT diff --git a/doc/Makefile.am b/doc/Makefile.am index e966e95..c10ce63 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = application-api-guide +SUBDIRS = application-api-guide helper-guide if user_guide SUBDIRS += implementers-guide users-guide process-guide diff --git a/doc/helper-guide/.gitignore b/doc/helper-guide/.gitignore new file mode 100644 index 0000000..53752db --- /dev/null +++ b/doc/helper-guide/.gitignore @@ -0,0 +1 @@ +output diff --git a/doc/helper-guide/Doxyfile b/doc/helper-guide/Doxyfile new file mode 100644 index 0000000..bcc2453 --- /dev/null +++ b/doc/helper-guide/Doxyfile @@ -0,0 +1,45 @@ +PROJECT_NAME = "Helper Reference Manual for $(WITH_PLATFORM)" +PROJECT_NUMBER = $(VERSION) +PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg +QUIET = YES +OUTPUT_DIRECTORY = $(DOCDIR) +FULL_PATH_NAMES = NO +JAVADOC_AUTOBRIEF = YES +OPTIMIZE_OUTPUT_FOR_C = YES +TYPEDEF_HIDES_STRUCT = NO +EXTRACT_STATIC = YES +SORT_MEMBER_DOCS = NO +WARN_NO_PARAMDOC = YES +INPUT = $(SRCDIR)/doc/helper-guide \ + $(SRCDIR)/helper/include +FILE_PATTERNS = *.h odp*.c *.dox +RECURSIVE = YES +SOURCE_BROWSER = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +ALPHABETICAL_INDEX = NO +QHP_NAMESPACE = +GENERATE_TREEVIEW = YES +PAPER_TYPE = a4wide +CLASS_DIAGRAMS = NO +HAVE_DOT = YES +CALL_GRAPH = YES +DOT_MULTI_TARGETS = NO +EXAMPLE_PATTERNS = *.c +EXAMPLE_RECURSIVE = YES +IMAGE_PATH = $(SRCDIR)/doc/images +HTML_EXTRA_STYLESHEET = $(SRCDIR)/doc/odpdoxygen.css +LAYOUT_FILE = $(SRCDIR)/doc/doxygenlayout.xml +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = __GNUC__ \ + __attribute__(x)= \ + ODP_ALIGNED(x)= \ + __BIG_ENDIAN_BITFIELD \ + __LITTLE_ENDIAN_BITFIELD \ + __x86_64__ \ + ODP_PACKED \ + "ODP_HANDLE_T(type)=odp_handle_t type" +INTERNAL_DOCS = YES +DOT_IMAGE_FORMAT = svg diff --git a/doc/helper-guide/Makefile.am b/doc/helper-guide/Makefile.am new file mode 100644 index 0000000..f8d568d --- /dev/null +++ b/doc/helper-guide/Makefile.am @@ -0,0 +1,6 @@ +EXTRA_DIST = \ + odp.dox \ + Doxyfile + +clean-local: + rm -rf output diff --git a/doc/helper-guide/odp.dox b/doc/helper-guide/odp.dox new file mode 100644 index 0000000..0a86d47 --- /dev/null +++ b/doc/helper-guide/odp.dox @@ -0,0 +1,26 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** + * @mainpage + * + * @section sec_1 Introduction + * + * OpenDataPlane (ODP) provides a data plane application programming + * environment that is easy to use, high performance, and portable + * between networking SoCs. + * + * The helper library provides support for commonly used functionality that is + * not directly accelerated by the hardware. + * + * @image html overview.svg + * + * @section contact Contact Details + * - The main web site is http://www.opendataplane.org/ + * - The git repo is https://git.linaro.org/lng/odp.git + * - Bug tracking is https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane + * + */ diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 index 998afe9..183c929 100644 --- a/doc/m4/configure.m4 +++ b/doc/m4/configure.m4 @@ -37,6 +37,7 @@ AC_ARG_ENABLE([user-guides], fi AC_CONFIG_FILES([doc/application-api-guide/Makefile + doc/helper-guide/Makefile doc/implementers-guide/Makefile doc/Makefile doc/process-guide/Makefile -- 2.7.4 _______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org https://lists.linaro.org/mailman/listinfo/lng-odp