Skip to content

Commit

Permalink
[NaCl SDK Docs] Simplify PPAPI documentation generation.
Browse files Browse the repository at this point in the history
* Modified chrome_sidenav.json to point to the correct locations.
* Added new template Doxygen config files for PPAPI C/C++ to the
  native_client_sdk directory.
* Copied doxy_cleanup.py from ppapi/c/documentation, and moved it to
  native_client_sdk, with some cleanup
* Modified doxygen header/footer to generate for chromesite
* Added generate_docs.py script. This automates nearly all of the
  doxygen documentation generation: gets the current stable/beta/dev branches,
  downloads ppapi via SVN, runs doxygen, runs doxy_cleanup, and generates
  ReST files for reference indexes.

No tryjobs because this is a documentation-only change.

BUG=none
R=awatson@chromium.org, sbc@chromium.org

Review URL: https://codereview.chromium.org/136033007

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@245362 0039d316-1c4b-4281-b951-d872f2087c98
  • Loading branch information
binji@chromium.org committed Jan 16, 2014
1 parent 587702a commit d1cfb7e
Show file tree
Hide file tree
Showing 21 changed files with 2,716 additions and 29 deletions.
32 changes: 14 additions & 18 deletions chrome/common/extensions/docs/templates/json/chrome_sidenav.json
Original file line number Diff line number Diff line change
Expand Up @@ -775,39 +775,35 @@
},
{
"title": "Pepper API Reference",
"href": "/native-client/index.html",
"href": "/native-client/pepper_stable/index.html",
"items": [
{
"title": "Structures",
"href": "/native-client/index.html"
"title": "Pepper C Interfaces",
"href": "/native-client/pepper_stable/c/group___interfaces.html"
},
{
"title": "Functions",
"href": "/native-client/index.html"
"title": "Pepper C Structures",
"href": "/native-client/pepper_stable/c/group___structs.html"
},
{
"title": "Enums",
"href": "/native-client/index.html"
"title": "Pepper C Functions",
"href": "/native-client/pepper_stable/c/group___functions.html"
},
{
"title": "Typedefs",
"href": "/native-client/index.html"
"title": "Pepper C Enums",
"href": "/native-client/pepper_stable/c/group___enums.html"
},
{
"title": "Macros",
"href": "/native-client/index.html"
"title": "Pepper C Typedefs",
"href": "/native-client/pepper_stable/c/group___typedefs.html"
},
{
"title": "Files",
"href": "/native-client/index.html"
"title": "Pepper C Macros",
"href": "/native-client/pepper_stable/c/global_defs.html"
},
{
"title": "Pepper C++ Classes",
"href": "/native-client/index.html"
},
{
"title": "Pepper C++ Files",
"href": "/native-client/index.html"
"href": "/native-client/pepper_stable/cpp/inherits.html"
}
]
},
Expand Down
75 changes: 75 additions & 0 deletions native_client_sdk/src/doc/doxygen/Doxyfile.c.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Copyright (c) 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Doxyfile 1.7.6.1
#
# Specified below are only the values that differ from the defaults. To see the
# default values, run:
#
# doxygen -g Doxyfile.defaults


# These entries will be modified by generate_docs.py
OUTPUT_DIRECTORY = %(out_dirname)s
INPUT = %(doc_dirname)s/c
EXCLUDE = %(doc_dirname)s/c/pp_macros.h

# These entries are fixed.
PROJECT_NAME =
BRIEF_MEMBER_DESC = NO
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
INLINE_INHERITED_MEMB = YES
JAVADOC_AUTOBRIEF = YES
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
CASE_SENSE_NAMES = NO
SHOW_INCLUDE_FILES = NO
MAX_INITIALIZER_LINES = 27
LAYOUT_FILE = DoxygenLayout.xml
FILE_PATTERNS = *.h \
*.dox
EXCLUDE_PATTERNS = _*.h
EXAMPLE_PATTERNS = *
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
HTML_OUTPUT =
HTML_HEADER = header.html
HTML_FOOTER = footer.html
HTML_STYLESHEET = stylesheet.css
HTML_COLORSTYLE_HUE = 217
TREEVIEW_WIDTH = 251
SEARCHENGINE = NO
GENERATE_LATEX = NO
PAPER_TYPE = a4wide
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = __native_client__ \
DOXYGEN_SHOULD_SKIP_THIS \
__attribute__(x)= \
EXTERN_C_BEGIN= \
EXTERN_C_END= \
PP_COMPILE_ASSERT_SIZE_IN_BYTES= \
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES= \
PP_INLINE= \
PP_EXPORT
CLASS_DIAGRAMS = NO
HAVE_DOT = YES
DOT_NUM_THREADS = 4
DOT_FONTNAME = FreeSans.ttf
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
GRAPHICAL_HIERARCHY = NO
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO
76 changes: 76 additions & 0 deletions native_client_sdk/src/doc/doxygen/Doxyfile.cpp.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Copyright (c) 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Doxyfile 1.7.6.1
#
# Specified below are only the values that differ from the defaults. To see the
# default values, run:
#
# doxygen -g Doxyfile.defaults


# These entries will be modified by generate_docs.py
OUTPUT_DIRECTORY = %(out_dirname)s
INPUT = %(doc_dirname)s/cpp \
%(doc_dirname)s/utility
EXCLUDE = %(doc_dirname)s/cpp/array_output.h \
%(doc_dirname)s/cpp/output_traits.h \
%(doc_dirname)s/utility/completion_callback_factory_thread_traits.h

# These entries are fixed.
PROJECT_NAME =
BRIEF_MEMBER_DESC = NO
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
JAVADOC_AUTOBRIEF = YES
EXTRACT_ALL = YES
CASE_SENSE_NAMES = NO
SHOW_INCLUDE_FILES = NO
MAX_INITIALIZER_LINES = 27
LAYOUT_FILE = DoxygenLayout.xml
FILE_PATTERNS = *.h \
*.dox
EXCLUDE_PATTERNS = _*.h
EXAMPLE_PATTERNS = *
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
HTML_OUTPUT =
HTML_HEADER = header.html
HTML_FOOTER = footer.html
HTML_STYLESHEET = stylesheet.css
HTML_COLORSTYLE_HUE = 217
TREEVIEW_WIDTH = 251
SEARCHENGINE = NO
GENERATE_LATEX = NO
PAPER_TYPE = a4wide
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = __native_client__ \
DOXYGEN_SHOULD_SKIP_THIS \
__attribute__(x)= \
EXTERN_C_BEGIN= \
EXTERN_C_END= \
PP_COMPILE_ASSERT_SIZE_IN_BYTES= \
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES= \
PP_INLINE= \
PP_EXPORT
CLASS_DIAGRAMS = NO
HAVE_DOT = YES
DOT_NUM_THREADS = 4
DOT_FONTNAME = FreeSans.ttf
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
DOT_GRAPH_MAX_NODES = 57
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO
Loading

0 comments on commit d1cfb7e

Please sign in to comment.