diff options
author | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-05-26 17:48:31 +0300 |
---|---|---|
committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-05-26 19:12:53 +0300 |
commit | f2bdc6c73933ffaa57894130a0af1295d1ef0343 (patch) | |
tree | cc13afd33862c207aa1d9bdc2d5356ef9464104d /doc | |
parent | 23edd52f14448057186cf320c56f6138c9b9f256 (diff) |
Revert "doc: generate a pure application-api-guide"
This reverts commit e4c596a4ec4b0d37e9b295ec42499ed8b4c1063d.
Commit breaks distribution, reverting it for now.
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/application-api-guide/Doxyfile | 50 | ||||
-rw-r--r-- | doc/application-api-guide/Doxyfile_common | 32 | ||||
-rw-r--r-- | doc/m4/configure.m4 | 1 | ||||
-rw-r--r-- | doc/platform-api-guide/.gitignore | 1 | ||||
-rw-r--r-- | doc/platform-api-guide/Doxyfile | 19 | ||||
-rw-r--r-- | doc/platform-api-guide/Makefile.am | 8 |
7 files changed, 44 insertions, 69 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 3fdec8f77..c10ce6339 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = application-api-guide helper-guide platform-api-guide +SUBDIRS = application-api-guide helper-guide if user_guide SUBDIRS += implementers-guide users-guide process-guide diff --git a/doc/application-api-guide/Doxyfile b/doc/application-api-guide/Doxyfile index 59afa1bbc..97731b2c1 100644 --- a/doc/application-api-guide/Doxyfile +++ b/doc/application-api-guide/Doxyfile @@ -1,12 +1,48 @@ -@INCLUDE = $(SRCDIR)/doc/application-api-guide/Doxyfile_common - -PROJECT_NAME = "API Reference Manual" +PROJECT_NAME = "API 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/application-api-guide \ - $(SRCDIR)/include -EXCLUDE_PATTERNS = drv* odp_drv.h -EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR) + $(SRCDIR)/include \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) +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_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) +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" -WARNINGS = NO +INTERNAL_DOCS = YES +DOT_IMAGE_FORMAT = svg diff --git a/doc/application-api-guide/Doxyfile_common b/doc/application-api-guide/Doxyfile_common deleted file mode 100644 index 595585354..000000000 --- a/doc/application-api-guide/Doxyfile_common +++ /dev/null @@ -1,32 +0,0 @@ -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 -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 -INTERNAL_DOCS = YES -DOT_IMAGE_FORMAT = svg diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 index ed9451dff..183c9298a 100644 --- a/doc/m4/configure.m4 +++ b/doc/m4/configure.m4 @@ -40,6 +40,5 @@ AC_CONFIG_FILES([doc/application-api-guide/Makefile doc/helper-guide/Makefile doc/implementers-guide/Makefile doc/Makefile - doc/platform-api-guide/Makefile doc/process-guide/Makefile doc/users-guide/Makefile]) diff --git a/doc/platform-api-guide/.gitignore b/doc/platform-api-guide/.gitignore deleted file mode 100644 index 53752db25..000000000 --- a/doc/platform-api-guide/.gitignore +++ /dev/null @@ -1 +0,0 @@ -output diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile deleted file mode 100644 index 72b7e1fb3..000000000 --- a/doc/platform-api-guide/Doxyfile +++ /dev/null @@ -1,19 +0,0 @@ -@INCLUDE = $(SRCDIR)/doc/application-api-guide/Doxyfile_common - -PROJECT_NAME = "API Reference Manual for $(WITH_PLATFORM)" -PROJECT_NUMBER = $(VERSION) -PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg -INPUT = $(SRCDIR)/doc/application-api-guide \ - $(SRCDIR)/doc/platform-api-guide \ - $(SRCDIR)/include \ - $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) -EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) -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" diff --git a/doc/platform-api-guide/Makefile.am b/doc/platform-api-guide/Makefile.am deleted file mode 100644 index 6109e825d..000000000 --- a/doc/platform-api-guide/Makefile.am +++ /dev/null @@ -1,8 +0,0 @@ -EXTRA_DIST = \ - api_guide_lines.dox \ - examples.dox \ - odp.dox \ - release.dox - -clean-local: - rm -rf output
\ No newline at end of file |