Package 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.

Reviewers in this package are responsible for analyzing project files of supported types and extracting custom documentation guidance. This guidance, typically annotated with the @guidance tag in comments, is used to automate documentation workflows and improve code quality.

Common reviewer logic includes reading files, parsing for annotated documentation fragments, and formatting outputs for further processing.

Supported reviewers:

Reviewers implement the Reviewer interface for standardized access and automation.

When adding or updating code in this package, ensure every public or protected class, interface, method, and field has a clear, comprehensive Javadoc. See @guidance for detailed documentation standards.

Usage Example: 

   Reviewer reviewer = new JavaReviewer();
   String guidance = reviewer.perform(new File("/project/root"), new File("src/Example.java"));
   if (guidance != null) {
       // use extracted guidance for documentation
   }