1 files changed, 67 insertions, 0 deletions
diff --git a/grpc/tools/distrib/c-ish/check_documentation.py b/grpc/tools/distrib/c-ish/check_documentation.py
new file mode 100755
index 00000000..fef8f4ee
--- /dev/null
+++ b/grpc/tools/distrib/c-ish/check_documentation.py
@@ -0,0 +1,67 @@
+#!/usr/bin/env python2.7
+
+# Copyright 2015 gRPC authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# check for directory level 'README.md' files
+# check that all implementation and interface files have a \file doxygen comment
+
+import os
+import sys
+
+# where do we run
+_TARGET_DIRS = [
+    'include/grpc', 'include/grpc++', 'src/core', 'src/cpp', 'test/core',
+    'test/cpp'
+]
+
+# which file extensions do we care about
+_INTERESTING_EXTENSIONS = ['.c', '.h', '.cc']
+
+# find our home
+_ROOT = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '../../..'))
+os.chdir(_ROOT)
+
+errors = 0
+
+# walk directories, find things
+printed_banner = False
+for target_dir in _TARGET_DIRS:
+    for root, dirs, filenames in os.walk(target_dir):
+        if 'README.md' not in filenames:
+            if not printed_banner:
+                print 'Missing README.md'
+                print '================='
+                printed_banner = True
+            print root
+            errors += 1
+if printed_banner: print
+printed_banner = False
+for target_dir in _TARGET_DIRS:
+    for root, dirs, filenames in os.walk(target_dir):
+        for filename in filenames:
+            if os.path.splitext(filename)[1] not in _INTERESTING_EXTENSIONS:
+                continue
+            path = os.path.join(root, filename)
+            with open(path) as f:
+                contents = f.read()
+            if '\\file' not in contents:
+                if not printed_banner:
+                    print 'Missing \\file comment'
+                    print '======================'
+                    printed_banner = True
+                print path
+                errors += 1
+
+assert errors == 0, 'error count = %d' % errors