Skip to content

Commit

Permalink
Add doxygen setups for internal documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ctiller committed May 29, 2015
1 parent a3c9fb0 commit 6c4ae60
Show file tree
Hide file tree
Showing 8 changed files with 4,745 additions and 5 deletions.
2 changes: 2 additions & 0 deletions templates/tools/doxygen/Doxyfile.c++.internal.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc++'], 'C++', libs, True)}
2 changes: 1 addition & 1 deletion templates/tools/doxygen/Doxyfile.c++.template
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc++'], 'C++', libs)}
${gen_doxyfile(['grpc++'], 'C++', libs, False)}
2 changes: 2 additions & 0 deletions templates/tools/doxygen/Doxyfile.core.internal.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc', 'gpr'], 'Core', libs, True)}
2 changes: 1 addition & 1 deletion templates/tools/doxygen/Doxyfile.core.template
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc', 'gpr'], 'Core', libs)}
${gen_doxyfile(['grpc', 'gpr'], 'Core', libs, False)}
10 changes: 8 additions & 2 deletions templates/tools/doxygen/Doxyfile.include
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<%def name="gen_doxyfile(libnames, packagename, collection)">
<%def name="gen_doxyfile(libnames, packagename, collection, internal)">
<%
import itertools
targets = []
Expand Down Expand Up @@ -770,7 +770,13 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = ${' '.join(itertools.chain.from_iterable(target.public_headers for target in targets))}
INPUT = ${' '.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
Expand Down
2,365 changes: 2,365 additions & 0 deletions tools/doxygen/Doxyfile.c++.internal

Large diffs are not rendered by default.

2,365 changes: 2,365 additions & 0 deletions tools/doxygen/Doxyfile.core.internal

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tools/doxygen/run_doxygen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ set -ex
# change to grpc repo root
cd $(dirname $0)/../..

for i in core c++
for i in core c++ core.internal c++.internal
do
mkdir -p doc/ref/$i
doxygen tools/doxygen/Doxyfile.$i
Expand Down

0 comments on commit 6c4ae60

Please sign in to comment.