Merge pull request #9274 An error occurred from ctiller/modulenotes

Stub documentation for core modules

src/core/ext/README.md

@@ -0,0 +1,5 @@
+Optional plugins for gRPC Core: Modules in this directory extend gRPC Core in
+useful ways. All optional code belongs here.
+
+NOTE: The movement of code between lib and ext is an ongoing effort, so this
+directory currently contains too much of the core library.

src/core/ext/resolver/README.md

@@ -0,0 +1,4 @@
+# Resolver
+
+Implementations of various name resolution schemes.
+See the [naming spec](/doc/naming.md).

src/core/ext/transport/README.md

@@ -0,0 +1 @@
+Transports for gRPC

src/core/ext/transport/chttp2/README.md

@@ -0,0 +1 @@
+CHTTP2 - gRPC's implementation of a HTTP2 based transport

src/core/lib/README.md

@@ -0,0 +1,6 @@
+Required elements of gRPC Core: Each module in this directory is required to
+build gRPC. If it's possible to envisage a configuration where code is not
+required, then that code belongs in ext/ instead.
+
+NOTE: The movement of code between lib and ext is an ongoing effort, so this
+directory currently contains too much of the core library.

src/core/lib/channel/README.md

@@ -0,0 +1,4 @@
+# Channel
+
+Provides channel/call stack implementation, and implementation of common filters
+for that implementation.

src/core/lib/iomgr/README.md

@@ -0,0 +1,6 @@
+# iomgr
+
+Platform abstractions for I/O (mostly network).
+
+Provides abstractions over TCP/UDP I/O, file loading, polling, and concurrency
+management for various operating systems.

src/core/lib/surface/README.md

@@ -0,0 +1,4 @@
+# Surface
+
+Surface provides the bulk of the gRPC Core public API, and translates it into
+calls against core components.

src/core/lib/transport/README.md

@@ -0,0 +1,7 @@
+# Transport
+
+Common implementation details for gRPC Transports.
+
+Transports multiplex messages across some single connection. In ext/ there are
+implementations atop [a custom http2 implementation](/src/core/ext/transport/chttp2/README.md)
+and atop [cronet](/src/core/ext/transport/cronet/README.md).

src/core/lib/tsi/README.md

@@ -0,0 +1,2 @@
+# Transport Security Interface
+An abstraction library over crypto and auth modules (typically OpenSSL)

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)
     )
 }
 

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

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