From d9ed57c0d75f872ca8e6a767046f8814db9dfde4 Mon Sep 17 00:00:00 2001
From: Craig Tiller <ctiller@google.com>
Date: Fri, 6 Jan 2017 13:14:06 -0800
Subject: [PATCH] Stub documentation for some gRPC Core modules
---
templates/tools/doxygen/Doxyfile.include | 9 ++++++++-
tools/doxygen/Doxyfile.c++.internal | 3 ++-
tools/doxygen/Doxyfile.core.internal | 23 ++++++++++++++++++++++-
3 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/templates/tools/doxygen/Doxyfile.include b/templates/tools/doxygen/Doxyfile.include
index 7fe8a29746..a22f07f33f 100644
--- a/templates/tools/doxygen/Doxyfile.include
+++ b/templates/tools/doxygen/Doxyfile.include
@@ -9,6 +9,7 @@
<%
import itertools
import glob
+ import os
targets = []
docpackage = packagename.replace('+', 'p').lower()
for libname in libnames:
@@ -18,6 +19,11 @@
target = p
assert(target)
targets.append(target)
+ srcdoc = []
+ for dirpath, dirnames, filenames in os.walk('src/%s' % docpackage):
+ for filename in filenames:
+ if os.path.splitext(filename)[1] == '.md':
+ srcdoc.append(os.path.join(dirpath, filename))
%>
# Doxyfile 1.8.9.1
@@ -790,7 +796,8 @@ INPUT = ${
else target.headers + target.src)
for target in targets),
glob.glob('doc/*.md'),
- glob.glob('doc/%s/*.md' % docpackage))
+ glob.glob('doc/%s/*.md' % docpackage),
+ [] if not internal else srcdoc)
)
}
diff --git a/tools/doxygen/Doxyfile.c++.internal b/tools/doxygen/Doxyfile.c++.internal
index e7fa25f1f1..89915d7b08 100644
--- a/tools/doxygen/Doxyfile.c++.internal
+++ b/tools/doxygen/Doxyfile.c++.internal
@@ -921,7 +921,8 @@ doc/interop-test-descriptions.md \
doc/statuscodes.md \
doc/g_stands_for.md \
doc/cpp/perf_notes.md \
-doc/cpp/pending_api_cleanups.md
+doc/cpp/pending_api_cleanups.md \
+src/cpp/README.md
# 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
diff --git a/tools/doxygen/Doxyfile.core.internal b/tools/doxygen/Doxyfile.core.internal
index b13afdca99..7048e0d601 100644
--- a/tools/doxygen/Doxyfile.core.internal
+++ b/tools/doxygen/Doxyfile.core.internal
@@ -1303,7 +1303,28 @@ doc/server-reflection.md \
doc/interop-test-descriptions.md \
doc/statuscodes.md \
doc/g_stands_for.md \
-doc/core/pending_api_cleanups.md
+doc/core/pending_api_cleanups.md \
+src/core/README.md \
+src/core/ext/README.md \
+src/core/ext/transport/README.md \
+src/core/ext/transport/chttp2/README.md \
+src/core/ext/transport/chttp2/client/secure/README.md \
+src/core/ext/transport/chttp2/client/insecure/README.md \
+src/core/ext/transport/chttp2/transport/README.md \
+src/core/ext/transport/chttp2/server/secure/README.md \
+src/core/ext/transport/chttp2/server/insecure/README.md \
+src/core/ext/client_channel/README.md \
+src/core/ext/resolver/README.md \
+src/core/ext/resolver/sockaddr/README.md \
+src/core/ext/resolver/dns/native/README.md \
+src/core/ext/census/README.md \
+src/core/ext/census/gen/README.md \
+src/core/lib/README.md \
+src/core/lib/tsi/README.md \
+src/core/lib/channel/README.md \
+src/core/lib/transport/README.md \
+src/core/lib/iomgr/README.md \
+src/core/lib/surface/README.md
# 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
--
GitLab