Package com.j3d.gen.docs.reader

Class J3DocsReader

java.lang.Object
com.j3d.gen.docs.reader.J3DocsReader
public class J3DocsReader extends Object
A utility class for parsing J3Engine's custom markdown-like documentation files (.j3.md). It reads the file content and converts it into a structured list of TWrapper objects, representing headers, paragraphs, code blocks, and other elements to be read by DocsFrame

The parser supports:

  • Headers (e.g., # Header 1, ## Header 2)
  • Horizontal rules (---)
  • Code blocks (fenced with ```)
  • Inline HTML tags (e.g., <tag src="...">)
  • Paragraphs with inline formatting (bold **text**, italic _text_, inline code `code`)
  • Links ([label](url))

Author:
Lehlogonolo Poole
See Also:

  • Constructor Details

    • J3DocsReader

      public J3DocsReader()

  • Method Details

    • parseFile

      public static ArrayList<TWrapper> parseFile(JarPath file)
      Parses a given file and returns a list of TWrapper objects representing the document structure.
      Parameters:
      file - The file to parse.
      Returns:
      An ArrayList of TWrapper objects.

    • read

      private static ArrayList<TWrapper> read(Scanner scanner)

    • unwrapPart

      private static TText unwrapPart(String part)

    • sw

      private static boolean sw(String part)