diff options
| author | Xavier Noria <fxn@hashref.com> | 2008-05-11 02:55:59 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2008-05-11 02:55:59 +0200 |
| commit | f4aaa2e99c350466e54afefdf278b4ba04008cd9 (patch) | |
| tree | 5b46b3e3418b95cd1e18d6a8f66d6d77bb5a4fc8 /railties/lib/source_annotation_extractor.rb | |
| parent | 80bba28a1a56a0cafeb0fc94659905e88129bc31 (diff) | |
| download | rails-f4aaa2e99c350466e54afefdf278b4ba04008cd9.tar.gz rails-f4aaa2e99c350466e54afefdf278b4ba04008cd9.tar.bz2 rails-f4aaa2e99c350466e54afefdf278b4ba04008cd9.zip | |
moved documentation header
Diffstat (limited to 'railties/lib/source_annotation_extractor.rb')
| -rw-r--r-- | railties/lib/source_annotation_extractor.rb | 29 |
1 files changed, 14 insertions, 15 deletions
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 <tt>rake -T notes</tt> and <tt>railties/lib/tasks/annotations.rake</tt>. +# +# Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> 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 <tt>rake -T notes</tt> and <tt>railties/lib/tasks/annotations.rake</tt>. - # - # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> 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: |