View on GitHub
@param detector_name [String] - the detector class that was parsed out of the original
comment, e.g. "DuplicateMethodCall" or "UnknownSmellDetector"
@param original_comment [String] - the original comment as found in the source code
@param line [Integer] - start of the expression the comment belongs to
@param source [String] - path to source file or "string"
@param options [String] - the configuration options as String for the detector that were
extracted from the original comment
- Add a comment describing the method.
- Add a code example (optional).