Package org.machanism.machai.gw.reviewer

Class MarkdownReviewer

java.lang.Object

org.machanism.machai.gw.reviewer.MarkdownReviewer

All Implemented Interfaces:

Reviewer

public class MarkdownReviewer
extends Object
implements Reviewer

Reviewer implementation for Markdown files (.md).

Extracts documented guidance from Markdown content using a special tag for input into automated documentation workflows.

Constructor Summary

Constructors

Constructor	Description
MarkdownReviewer()

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedFileExtentions()	Returns the file extensions supported by this reviewer.
String	perform(File projectDir, File guidancesFile)	Reviews the given Markdown file for contained guidance comments and formats the content for input to documentation generators.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.machanism.machai.gw.reviewer.Reviewer

setDirGuidanceMap

Constructor Details

MarkdownReviewer

public MarkdownReviewer()

Method Details

getSupportedFileExtentions

public String[] getSupportedFileExtentions()

Returns the file extensions supported by this reviewer. This reviewer handles files with the 'md' extension.

Specified by:

getSupportedFileExtentions in interface Reviewer

Returns:

an array of supported file extension strings

perform

public String perform(File projectDir,
 File guidancesFile)
               throws IOException

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

Specified by:

perform in interface Reviewer

Parameters:

projectDir - the root directory of the project for context

guidancesFile - the Markdown file to be analyzed

Returns:

formatted documentation guidance or null if none found

Throws:

IOException - if an error occurs reading the file