Merge pull request #1783 from ctiller/whisper-sweet-nothings-to-yourself

Add doxygen setups for internal documentation
pull/1830/head
David G. Quintas 10 years ago
commit eaee2bcb32
  1. 2
      templates/tools/doxygen/Doxyfile.c++.internal.template
  2. 2
      templates/tools/doxygen/Doxyfile.c++.template
  3. 2
      templates/tools/doxygen/Doxyfile.core.internal.template
  4. 2
      templates/tools/doxygen/Doxyfile.core.template
  5. 10
      templates/tools/doxygen/Doxyfile.include
  6. 2365
      tools/doxygen/Doxyfile.c++.internal
  7. 2365
      tools/doxygen/Doxyfile.core.internal
  8. 2
      tools/doxygen/run_doxygen.sh

@ -0,0 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc++'], 'C++', libs, True)}

@ -1,2 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\ <%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc++'], 'C++', libs)} ${gen_doxyfile(['grpc++'], 'C++', libs, False)}

@ -0,0 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc', 'gpr'], 'Core', libs, True)}

@ -1,2 +1,2 @@
<%namespace file="Doxyfile.include" import="gen_doxyfile"/>\ <%namespace file="Doxyfile.include" import="gen_doxyfile"/>\
${gen_doxyfile(['grpc', 'gpr'], 'Core', libs)} ${gen_doxyfile(['grpc', 'gpr'], 'Core', libs, False)}

@ -1,4 +1,4 @@
<%def name="gen_doxyfile(libnames, packagename, collection)"> <%def name="gen_doxyfile(libnames, packagename, collection, internal)">
<% <%
import itertools import itertools
targets = [] targets = []
@ -770,7 +770,13 @@ WARN_LOGFILE =
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # 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 # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

@ -34,7 +34,7 @@ set -ex
# change to grpc repo root # change to grpc repo root
cd $(dirname $0)/../.. cd $(dirname $0)/../..
for i in core c++ for i in core c++ core.internal c++.internal
do do
mkdir -p doc/ref/$i mkdir -p doc/ref/$i
doxygen tools/doxygen/Doxyfile.$i doxygen tools/doxygen/Doxyfile.$i

Loading…
Cancel
Save