third_party/grpc/templates/tools/doxygen/Doxyfile.include - Issue 1932353002: Initial checkin of gRPC to third_party/

Unified Diff: third_party/grpc/templates/tools/doxygen/Doxyfile.include

Issue 1932353002: Initial checkin of gRPC to third_party/ Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 8 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « third_party/grpc/templates/tools/dockerfile/test/sanity/Dockerfile.template ('k') | third_party/grpc/templates/tools/doxygen/Doxyfile.c++.template » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: third_party/grpc/templates/tools/doxygen/Doxyfile.include

diff --git a/third_party/crashpad/crashpad/doc/support/crashpad.doxy b/third_party/grpc/templates/tools/doxygen/Doxyfile.include

similarity index 98%

copy from third_party/crashpad/crashpad/doc/support/crashpad.doxy

copy to third_party/grpc/templates/tools/doxygen/Doxyfile.include

index 276a79455a95e86416f8c51ac471d060c249e44d..8b0c528c1f68f5eee14b6609d5cab25c6fe0fc92 100644

--- a/third_party/crashpad/crashpad/doc/support/crashpad.doxy

+++ b/third_party/grpc/templates/tools/doxygen/Doxyfile.include

@@ -1,3 +1,22 @@

+## Populates "targets" for all names in the collection "libnames" that are

+## part of "collection".

+##

+## Note that "packagename" and "internal" while not used

+## in the function itself are referenced in the template.

+## When "internal" is true, documentation for non-public headers

+## and sources is also taken as input to Doxygen (see INPUT).

+<%def name="gen_doxyfile(libnames, packagename, collection, internal)">

+<%

+ import itertools

+ targets = []

+ for libname in libnames:

+ target = None

+ for p in collection:

+ if p.name == libname:

+ target = p

+ assert(target)

+ targets.append(target)

+%>

# Doxyfile 1.8.9.1

# This file describes the settings to be used by the documentation system

@@ -32,13 +51,13 @@ DOXYFILE_ENCODING = UTF-8

# title of most generated pages and in a few other places.

# The default value is: My Project.

-PROJECT_NAME = "Crashpad"

+PROJECT_NAME = "GRPC ${packagename}"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This

# could be handy for archiving the generated documentation or if some version

# control system is used.

-PROJECT_NUMBER =

+PROJECT_NUMBER = ${settings.core_version if packagename=='Core' else settings.cpp_version}

# Using the PROJECT_BRIEF tag one can provide an optional one line description

# for a project that appears at the top of each page and should give viewer a

@@ -58,7 +77,8 @@ PROJECT_LOGO =

# entered, it will be relative to the location where doxygen was started. If

# left blank the current directory will be used.

-OUTPUT_DIRECTORY = out/doc/doxygen

+OUTPUT_DIRECTORY = doc/ref/${

+ packagename.lower() + ('.internal' if internal else '')}

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-

# directories (in 2 levels) under the output directory of each output format and

@@ -161,9 +181,7 @@ STRIP_FROM_PATH =

# specify the list of include paths that are normally passed to the compiler

# using the -I flag.

-STRIP_FROM_INC_PATH = . \

- compat/mac \

- compat/non_win

+STRIP_FROM_INC_PATH =

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but

# less readable) file names. This can be useful is your file systems doesn't

@@ -179,7 +197,7 @@ SHORT_NAMES = NO

# description.)

# The default value is: NO.

-JAVADOC_AUTOBRIEF = NO

+JAVADOC_AUTOBRIEF = YES

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first

# line (until the first dot) of a Qt-style comment as the brief description. If

@@ -218,7 +236,7 @@ SEPARATE_MEMBER_PAGES = NO

# uses this value to replace tabs by spaces in code fragments.

# Minimum value: 1, maximum value: 16, default value: 4.

-TAB_SIZE = 4

+TAB_SIZE = 2

# This tag can be used to specify a number of aliases that act as commands in

# the documentation. An alias has the form:

@@ -244,7 +262,7 @@ TCL_SUBST =

# members will be omitted, etc.

# The default value is: NO.

-OPTIMIZE_OUTPUT_FOR_C = NO

+OPTIMIZE_OUTPUT_FOR_C = YES

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or

# Python sources only. Doxygen will then generate output that is more tailored

@@ -343,7 +361,7 @@ IDL_PROPERTY_SUPPORT = YES

# all members of a group must be documented explicitly.

# The default value is: NO.

-DISTRIBUTE_GROUP_DOC = YES

+DISTRIBUTE_GROUP_DOC = NO

# Set the SUBGROUPING tag to YES to allow class member groups of the same type

# (for instance a group of public functions) to be put as a subgroup of that

@@ -411,7 +429,7 @@ LOOKUP_CACHE_SIZE = 0

# normally produced when WARNINGS is set to YES.

# The default value is: NO.

-EXTRACT_ALL = NO

+EXTRACT_ALL = YES

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will

# be included in the documentation.

@@ -500,7 +518,7 @@ INTERNAL_DOCS = NO

# and Mac users are advised to set this option to NO.

# The default value is: system dependent.

-CASE_SENSE_NAMES = YES

+CASE_SENSE_NAMES = NO

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with

# their full class and namespace scopes in the documentation. If set to YES, the

@@ -533,7 +551,7 @@ SHOW_GROUPED_MEMB_INC = NO

# files with double quotes in the documentation rather than with sharp brackets.

# The default value is: NO.

-FORCE_LOCAL_INCLUDES = YES

+FORCE_LOCAL_INCLUDES = NO

# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the

# documentation for inline members.

@@ -760,7 +778,13 @@ WARN_LOGFILE =

# spaces.

# Note: If this tag is empty the current directory is searched.

-INPUT =

+INPUT = ${' \\\n'.join(

+ itertools.chain.from_iterable(

+ target.public_headers +

+ ([]

+ if not internal

+ else target.headers + target.src)

+ for target in targets))}

# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

@@ -780,17 +804,13 @@ INPUT_ENCODING = UTF-8

# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,

# *.qsf, *.as and *.js.

-FILE_PATTERNS = *.c \

- *.cc \

- *.h \

- *.m \

- *.mm

+FILE_PATTERNS =

# The RECURSIVE tag can be used to specify whether or not subdirectories should

# be searched for input files as well.

# The default value is: NO.

-RECURSIVE = YES

+RECURSIVE = NO

# The EXCLUDE tag can be used to specify files and/or directories that should be

# excluded from the INPUT source files. This way you can easily exclude a

@@ -799,7 +819,7 @@ RECURSIVE = YES

# Note that relative paths are relative to the directory from which doxygen is

# run.

-EXCLUDE = third_party

+EXCLUDE =

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or

# directories that are symbolic links (a Unix file system feature) are excluded

@@ -815,7 +835,7 @@ EXCLUDE_SYMLINKS = NO

# Note that the wildcards are matched against the file with absolute path, so to

# exclude all test directories for example use the pattern */test/*

-EXCLUDE_PATTERNS = out*

+EXCLUDE_PATTERNS =

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

# (namespaces, classes, functions, etc.) that should be excluded from the

@@ -986,7 +1006,7 @@ USE_HTAGS = NO

# See also: Section \class.

# The default value is: YES.

-VERBATIM_HEADERS = NO

+VERBATIM_HEADERS = YES

#---------------------------------------------------------------------------

# Configuration options related to the alphabetical class index

@@ -1139,7 +1159,7 @@ HTML_COLORSTYLE_GAMMA = 80

# The default value is: YES.

# This tag requires that the tag GENERATE_HTML is set to YES.

-HTML_TIMESTAMP = NO

+HTML_TIMESTAMP = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML

# documentation will contain sections that can be hidden and shown after the

@@ -1386,7 +1406,7 @@ GENERATE_TREEVIEW = NO

# Minimum value: 0, maximum value: 20, default value: 4.

# This tag requires that the tag GENERATE_HTML is set to YES.

-ENUM_VALUES_PER_LINE = 0

+ENUM_VALUES_PER_LINE = 4

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used

# to set the initial width (in pixels) of the frame in which the tree is shown.

@@ -1954,7 +1974,7 @@ MACRO_EXPANSION = YES

# The default value is: NO.

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

-EXPAND_ONLY_PREDEF = YES

+EXPAND_ONLY_PREDEF = NO

# If the SEARCH_INCLUDES tag is set to YES, the include files in the

# INCLUDE_PATH will be searched if a #include is found.

@@ -1986,11 +2006,7 @@ INCLUDE_FILE_PATTERNS =

# recursively expanded use the := operator instead of the = operator.

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

-PREDEFINED = ALIGNAS(x)= \

- DOXYGEN \

- MSVC_POP_WARNING()= \

- MSVC_PUSH_DISABLE_WARNING(x)= \

- __attribute__(x)=

+PREDEFINED = GRPC_FINAL= GRPC_OVERIDE=

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

# tag can be used to specify a list of macro names that should be expanded. The

@@ -2105,7 +2121,7 @@ HIDE_UNDOC_RELATIONS = YES

# set to NO

# The default value is: NO.

-HAVE_DOT = NO

+HAVE_DOT = YES

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed

# to run in parallel. When set to 0 doxygen will base this on the number of

@@ -2147,7 +2163,7 @@ DOT_FONTPATH =

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-CLASS_GRAPH = YES

+CLASS_GRAPH = NO

# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a

# graph for each documented class showing the direct and indirect implementation

@@ -2156,14 +2172,14 @@ CLASS_GRAPH = YES

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-COLLABORATION_GRAPH = YES

+COLLABORATION_GRAPH = NO

# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for

# groups, showing the direct groups dependencies.

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-GROUP_GRAPHS = YES

+GROUP_GRAPHS = NO

# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and

# collaboration diagrams in a style similar to the OMG's Unified Modeling

@@ -2201,7 +2217,7 @@ TEMPLATE_RELATIONS = NO

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-INCLUDE_GRAPH = YES

+INCLUDE_GRAPH = NO

# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are

# set to YES then doxygen will generate a graph for each documented file showing

@@ -2210,7 +2226,7 @@ INCLUDE_GRAPH = YES

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-INCLUDED_BY_GRAPH = YES

+INCLUDED_BY_GRAPH = NO

# If the CALL_GRAPH tag is set to YES then doxygen will generate a call

# dependency graph for every global function or class method.

@@ -2239,7 +2255,7 @@ CALLER_GRAPH = NO

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-GRAPHICAL_HIERARCHY = YES

+GRAPHICAL_HIERARCHY = NO

# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the

# dependencies a directory has on other directories in a graphical way. The

@@ -2248,7 +2264,7 @@ GRAPHICAL_HIERARCHY = YES

# The default value is: YES.

# This tag requires that the tag HAVE_DOT is set to YES.

-DIRECTORY_GRAPH = YES

+DIRECTORY_GRAPH = NO

# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images

# generated by dot.

@@ -2370,3 +2386,4 @@ GENERATE_LEGEND = YES

# This tag requires that the tag HAVE_DOT is set to YES.

DOT_CLEANUP = YES

+</%def>