Methods
Class Public methods
directories() Link
extensions() Link
register_directories(*dirs) Link
Registers additional directories to be included
Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
register_extensions(*exts, &block) Link
Registers new Annotations File
Extensions
Rails::SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
register_tags(*additional_tags) Link
Registers additional tags
Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")
Instance Public methods
to_s(options = {}) Link
Returns a representation of the annotation that looks like this:
[126] [TODO] This algorithm is simple and clearly correct, make it faster.
If options
has a flag :tag
the tag is shown as in the example above. Otherwise the string contains just line and text.