From f4aaa2e99c350466e54afefdf278b4ba04008cd9 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sun, 11 May 2008 02:55:59 +0200 Subject: moved documentation header --- railties/lib/source_annotation_extractor.rb | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) (limited to 'railties/lib') diff --git a/railties/lib/source_annotation_extractor.rb b/railties/lib/source_annotation_extractor.rb index 97e60a8ab8..591fd6f6bd 100644 --- a/railties/lib/source_annotation_extractor.rb +++ b/railties/lib/source_annotation_extractor.rb @@ -1,19 +1,18 @@ +# Implements the logic behind the rake tasks for annotations like +# +# rake notes +# rake notes:optimize +# +# and friends. See rake -T notes and railties/lib/tasks/annotations.rake. +# +# Annotation objects are triplets :line, :tag, :text that +# represent the line where the annotation lives, its tag, and its text. Note +# the filename is not stored. +# +# Annotations are looked for in comments and modulus whitespace they have to +# start with the tag optionally followed by a colon. Everything up to the end +# of the line (or closing ERb comment tag) is considered to be their text. class SourceAnnotationExtractor - - # Implements the logic behind the rake tasks for annotations like - # - # rake notes - # rake notes:optimize - # - # and friends. See rake -T notes and railties/lib/tasks/annotations.rake. - # - # Annotation objects are triplets :line, :tag, :text that - # represent the line where the annotation lives, its tag, and its text. Note - # the filename is not stored. - # - # Annotations are looked for in comments and modulus whitespace they have to - # start with the tag optionally followed by a colon. Everything up to the end - # of the line (or closing ERb comment tag) is considered to be their text. class Annotation < Struct.new(:line, :tag, :text) # Returns a representation of the annotation that looks like this: -- cgit v1.2.3