1 files changed, 74 insertions, 0 deletions
diff --git a/modules/doc_checker/doc_checker.py b/modules/doc_checker/doc_checker.py
new file mode 100644
index 0000000000..18650cdc5c
--- /dev/null
+++ b/modules/doc_checker/doc_checker.py
@@ -0,0 +1,74 @@
+# ex:ts=4:sw=4:sts=4:et
+# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
+#
+#
+# Copyright (C)       2005 Holger Hans Peter Freyther
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+#   Neither the name Holger Hans Peter Freyther nor the names of its
+#   contributors may be used to endorse or promote products derived
+#   from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+from bittest import TestItem
+
+import bb
+
+
+# black list of KEYs that are not needed to have a documentation
+_black_list = []
+
+class TestCase:
+    """
+    Check if variables carry a documentation. For each concrete bbfile
+    (which includes bbclasses) we will check if all keys are named.
+    """
+
+    def __init__(self):
+        """
+        Construct the test case...
+        """
+        pass
+
+    def test(self, file_name, file_data):
+        """
+        Now we will run the tests
+        """
+
+        results = []
+
+        #
+        # The big plot. We will go through every key of file_data
+        # and check if there is a doc Flag
+        #
+        for key in bb.data.keys(file_data):
+            flag = bb.data.getVarFlag(key,"doc", file_data)
+            if flag == None:
+                results.append( TestItem(file_name,False,"Attribute named '%s' lacks documentation." % key))
+
+        return results
+
+    def test_name(self):
+        return "Documentation Checker Tool"