public
Description: PLEASE CHECK http://github.com/lifo/docrails/wikis
Homepage: http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch
Clone URL: git://github.com/lifo/docrails.git
Search Repo:
moved documentation header
fxn (author)
Sat May 10 17:55:59 -0700 2008
commit  f4aaa2e99c350466e54afefdf278b4ba04008cd9
tree    5b46b3e3418b95cd1e18d6a8f66d6d77bb5a4fc8
parent  80bba28a1a56a0cafeb0fc94659905e88129bc31
...
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
17
18
0
@@ -1,19 +1,18 @@
0
+# Implements the logic behind the rake tasks for annotations like
0
+#
0
+# rake notes
0
+# rake notes:optimize
0
+#
0
+# and friends. See <tt>rake -T notes</tt> and <tt>railties/lib/tasks/annotations.rake</tt>.
0
+#
0
+# Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
0
+# represent the line where the annotation lives, its tag, and its text. Note
0
+# the filename is not stored.
0
+#
0
+# Annotations are looked for in comments and modulus whitespace they have to
0
+# start with the tag optionally followed by a colon. Everything up to the end
0
+# of the line (or closing ERb comment tag) is considered to be their text.
0
 class SourceAnnotationExtractor
0
-
0
- # Implements the logic behind the rake tasks for annotations like
0
- #
0
- # rake notes
0
- # rake notes:optimize
0
- #
0
- # and friends. See <tt>rake -T notes</tt> and <tt>railties/lib/tasks/annotations.rake</tt>.
0
- #
0
- # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
0
- # represent the line where the annotation lives, its tag, and its text. Note
0
- # the filename is not stored.
0
- #
0
- # Annotations are looked for in comments and modulus whitespace they have to
0
- # start with the tag optionally followed by a colon. Everything up to the end
0
- # of the line (or closing ERb comment tag) is considered to be their text.
0
   class Annotation < Struct.new(:line, :tag, :text)
0
 
0
     # Returns a representation of the annotation that looks like this:

Comments

    No one has commented yet.