Index

C E F G H I J M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values

C

CHAT_MODEL - Static variable in class org.machanism.machai.gw.Ghostwriter

Default chat model name constant.

E

extractPackageName(String) - Static method in class org.machanism.machai.gw.reviewer.JavaReviewer

Extracts the package name from the content of a package-info.java file.

F

FileProcessor - Class in org.machanism.machai.gw

Processor for project documentation generation.

FileProcessor(GenAIProvider) - Constructor for class org.machanism.machai.gw.FileProcessor

Constructs a FileProcessor for documentation input preparation.

G

getRootDir(File) - Method in class org.machanism.machai.gw.FileProcessor

Returns the root directory for documentation scanning, falling back to input if unset.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer

Returns the file extensions supported by this reviewer.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.JavaReviewer

Returns the file extensions supported by this reviewer.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer

Returns the file extensions supported by this reviewer.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.PythonReviewer

Returns the file extensions supported by this reviewer.

getSupportedFileExtentions() - Method in interface org.machanism.machai.gw.reviewer.Reviewer

Returns an array of supported file extensions for this reviewer.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.TextReviewer

Returns the file extensions supported by this reviewer.

getSupportedFileExtentions() - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer

Returns the file extensions supported by this reviewer.

Ghostwriter - Class in org.machanism.machai.gw

Entry point for document scanning and review automation.

Ghostwriter() - Constructor for class org.machanism.machai.gw.Ghostwriter

GUIDANCE_TAG_NAME - Static variable in class org.machanism.machai.gw.FileProcessor

Tag name for guidance comments.

H

HtmlReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for HTML files (.html, .htm).

HtmlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.HtmlReviewer

I

isInheritance() - Method in class org.machanism.machai.gw.FileProcessor

Returns true if directory guidance inheritance is enabled.

isUseParentsGuidances() - Method in class org.machanism.machai.gw.FileProcessor

Returns true if parent guidances are used in document preparation.

J

JavaReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for Java source files (.java).

JavaReviewer() - Constructor for class org.machanism.machai.gw.reviewer.JavaReviewer

M

main(String[]) - Static method in class org.machanism.machai.gw.Ghostwriter

Main entry point for document scanning run.

MarkdownReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for Markdown files (.md).

MarkdownReviewer() - Constructor for class org.machanism.machai.gw.reviewer.MarkdownReviewer

O

org.machanism.machai.gw - package org.machanism.machai.gw

Provides classes for document processing and code review automation in projects.

org.machanism.machai.gw.reviewer - package org.machanism.machai.gw.reviewer

Provides file reviewer implementations for various source formats including Java, Python, TypeScript, HTML, Markdown, and plain text.

P

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer

Reviews the given HTML file for contained guidance comments and formats the content for input to documentation generators.

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.JavaReviewer

Performs analysis on the specified Java source or package-info file, extracting documentation guidance if marked with the appropriate tag.

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer

Reviews the given Markdown file for contained guidance comments and formats the content for input to documentation generators.

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.PythonReviewer

Performs analysis on the specified Python source file, extracting documentation guidance if marked with the appropriate tag.

perform(File, File) - Method in interface org.machanism.machai.gw.reviewer.Reviewer

Analyzes and extracts guidance information from the specified file to aid documentation generation.

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TextReviewer

Analyzes a text file for documentation guidance and, if present, updates the context map.

perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer

Performs analysis on the specified TypeScript source file, extracting documentation guidance if marked with the appropriate tag.

processFolder(ProjectLayout) - Method in class org.machanism.machai.gw.FileProcessor

Processes the project layout for documentation gathering.

PythonReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for Python source files (.py).

PythonReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PythonReviewer

R

Reviewer - Interface in org.machanism.machai.gw.reviewer

Interface for file reviewers that analyze project files to extract or process guidance for documentation generation.

S

scanDocuments(File) - Method in class org.machanism.machai.gw.FileProcessor

Scans documents in the given root directory and prepares inputs for documentation generation.

scanDocuments(File, File) - Method in class org.machanism.machai.gw.FileProcessor

Scans documents in the given root directory and start subdirectory, preparing inputs for documentation generation.

scanFolder(File) - Method in class org.machanism.machai.gw.FileProcessor

Recursively scans project folders, processing documentation inputs for all found modules and files.

setDirGuidanceMap(Map<String, String>) - Method in interface org.machanism.machai.gw.reviewer.Reviewer

setDirGuidanceMap(Map<String, String>) - Method in class org.machanism.machai.gw.reviewer.TextReviewer

setInheritance(boolean) - Method in class org.machanism.machai.gw.FileProcessor

Sets whether directory guidance inheritance is enabled.

setUseParentsGuidances(boolean) - Method in class org.machanism.machai.gw.FileProcessor

Sets whether parent guidances are included in documentation preparation.

T

TextReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for generic text files (.txt).

TextReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TextReviewer

TypeScriptReviewer - Class in org.machanism.machai.gw.reviewer

Reviewer implementation for TypeScript source files (.ts).

TypeScriptReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TypeScriptReviewer

C E F G H I J M O P R S T
All Classes and Interfaces|All Packages|Constant Field Values