Package org.machanism.machai.gw.reviewer
Class MarkdownReviewer
java.lang.Object
org.machanism.machai.gw.reviewer.MarkdownReviewer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the file extensions supported by this reviewer.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, waitMethods inherited from interface org.machanism.machai.gw.reviewer.Reviewer
setDirGuidanceMap
-
Constructor Details
-
MarkdownReviewer
public MarkdownReviewer()
-
-
Method Details
-
getSupportedFileExtentions
Returns the file extensions supported by this reviewer. This reviewer handles files with the 'md' extension.- Specified by:
getSupportedFileExtentionsin interfaceReviewer- Returns:
- an array of supported file extension strings
-
perform
Reviews the given Markdown file for contained guidance comments and formats the content for input to documentation generators.- Specified by:
performin interfaceReviewer- Parameters:
projectDir- the root directory of the project for contextguidancesFile- the Markdown file to be analyzed- Returns:
- formatted documentation guidance or
nullif none found - Throws:
IOException- if an error occurs reading the file
-