Class DocumentationTest


  • public class DocumentationTest
    extends java.lang.Object
    Various automated checks on the documentation.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void addOperators​(java.util.Map<java.lang.String,​DocumentationTest.PatternOp> map, java.lang.String prefix, java.util.List<org.apache.calcite.sql.SqlOperator> operatorList)  
      void testAllFunctionsAreDocumented()
      Tests that every function in SqlStdOperatorTable is documented in reference.md.
      void testGenerateKeyWords()
      Generates a copy of reference.md with the current set of key words.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DocumentationTest

        public DocumentationTest()
    • Method Detail

      • testGenerateKeyWords

        public void testGenerateKeyWords()
                                  throws java.io.IOException
        Generates a copy of reference.md with the current set of key words. Fails if the copy is different from the original.
        Throws:
        java.io.IOException
      • testAllFunctionsAreDocumented

        public void testAllFunctionsAreDocumented()
                                           throws java.io.IOException
        Tests that every function in SqlStdOperatorTable is documented in reference.md.
        Throws:
        java.io.IOException
      • addOperators

        private void addOperators​(java.util.Map<java.lang.String,​DocumentationTest.PatternOp> map,
                                  java.lang.String prefix,
                                  java.util.List<org.apache.calcite.sql.SqlOperator> operatorList)