Package org.matheclipse.core.form

Class Documentation

  • public class Documentation
extends Object

    • Constructor Detail

      • Documentation

        public Documentation()

    • Method Detail

      • getMarkdown

        public static boolean getMarkdown​(Appendable out,
                                  String builinFunctionName)
        Get the pure markdown formatted information about the builinFunctionName
        Parameters:
        out -
        builinFunctionName -
        Returns:

      • findDocumentation

        public static void findDocumentation​(Appendable out,
                                     String trimmedInput)

      • findDocumentation

        public static IExpr findDocumentation​(String trimmedInput)

      • usageDocumentation

        public static void usageDocumentation​(Appendable out,
                                      String name)

      • printDocumentation

        public static boolean printDocumentation​(Appendable out,
                                         String symbolName)
        Load the documentation from resource folder if available and print to output.
        Parameters:
        symbolName -

      • buildFunctionFilename

        public static String buildFunctionFilename​(String symbolName)

      • buildDocFilename

        public static String buildDocFilename​(String docName)

      • extraxtJavadoc

        public static int extraxtJavadoc​(Appendable out,
                                 String symbolName)