Package org.machanism.machai.gw.reviewer

Interface Reviewer

All Known Implementing Classes:

HtmlReviewer, JavaReviewer, MarkdownReviewer, PythonReviewer, TextReviewer, TypeScriptReviewer

public interface Reviewer

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

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedFileExtentions()	Returns an array of supported file extensions for this reviewer.
String	perform(File projectDir, File file)	Analyzes and extracts guidance information from the specified file to aid documentation generation.
default void	setDirGuidanceMap(Map<String,String> dirGuidanceMap)

Method Details

perform

String perform(File projectDir,
 File file)
        throws IOException

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

Parameters:

projectDir - the root directory of the project for context

file - the file to be reviewed and analyzed

Returns:

the extracted guidance or documentation fragment, or null if none found

Throws:

IOException - if an error occurs reading the file

getSupportedFileExtentions

String[] getSupportedFileExtentions()

Returns an array of supported file extensions for this reviewer. These extensions determine which files the reviewer is capable of processing.

Returns:

an array of supported file extension strings (without dot)

setDirGuidanceMap

default void setDirGuidanceMap(Map<String,String> dirGuidanceMap)