voloko-sdoc 0.1.7 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. data/LICENSE +21 -0
  2. data/VERSION.yml +4 -0
  3. data/lib/sdoc/generator/shtml.rb +1 -4
  4. data/lib/sdoc.rb +0 -1
  5. metadata +32 -101
  6. data/rdoc/History.txt +0 -254
  7. data/rdoc/Manifest.txt +0 -126
  8. data/rdoc/README.txt +0 -47
  9. data/rdoc/RI.txt +0 -58
  10. data/rdoc/Rakefile +0 -70
  11. data/rdoc/bin/rdoc +0 -35
  12. data/rdoc/bin/ri +0 -5
  13. data/rdoc/lib/rdoc/alias.rb +0 -54
  14. data/rdoc/lib/rdoc/anon_class.rb +0 -10
  15. data/rdoc/lib/rdoc/any_method.rb +0 -190
  16. data/rdoc/lib/rdoc/attr.rb +0 -79
  17. data/rdoc/lib/rdoc/cache.rb +0 -41
  18. data/rdoc/lib/rdoc/class_module.rb +0 -87
  19. data/rdoc/lib/rdoc/code_object.rb +0 -152
  20. data/rdoc/lib/rdoc/code_objects.rb +0 -23
  21. data/rdoc/lib/rdoc/constant.rb +0 -36
  22. data/rdoc/lib/rdoc/context.rb +0 -712
  23. data/rdoc/lib/rdoc/diagram.rb +0 -340
  24. data/rdoc/lib/rdoc/dot.rb +0 -249
  25. data/rdoc/lib/rdoc/generator/darkfish.rb +0 -455
  26. data/rdoc/lib/rdoc/generator/markup.rb +0 -194
  27. data/rdoc/lib/rdoc/generator/ri.rb +0 -230
  28. data/rdoc/lib/rdoc/generator/template/darkfish/classpage.rhtml +0 -281
  29. data/rdoc/lib/rdoc/generator/template/darkfish/filepage.rhtml +0 -112
  30. data/rdoc/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
  31. data/rdoc/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
  32. data/rdoc/lib/rdoc/generator/template/darkfish/images/bug.png +0 -0
  33. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
  34. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png +0 -0
  35. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png +0 -0
  36. data/rdoc/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
  37. data/rdoc/lib/rdoc/generator/template/darkfish/images/find.png +0 -0
  38. data/rdoc/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif +0 -0
  39. data/rdoc/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png +0 -0
  40. data/rdoc/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
  41. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
  42. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_text.png +0 -0
  43. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
  44. data/rdoc/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
  45. data/rdoc/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
  46. data/rdoc/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
  47. data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
  48. data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
  49. data/rdoc/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
  50. data/rdoc/lib/rdoc/generator/template/darkfish/index.rhtml +0 -64
  51. data/rdoc/lib/rdoc/generator/template/darkfish/js/darkfish.js +0 -116
  52. data/rdoc/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -32
  53. data/rdoc/lib/rdoc/generator/template/darkfish/js/quicksearch.js +0 -114
  54. data/rdoc/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +0 -10
  55. data/rdoc/lib/rdoc/generator/template/darkfish/rdoc.css +0 -696
  56. data/rdoc/lib/rdoc/generator.rb +0 -8
  57. data/rdoc/lib/rdoc/ghost_method.rb +0 -8
  58. data/rdoc/lib/rdoc/include.rb +0 -39
  59. data/rdoc/lib/rdoc/known_classes.rb +0 -68
  60. data/rdoc/lib/rdoc/markup/attribute_manager.rb +0 -311
  61. data/rdoc/lib/rdoc/markup/formatter.rb +0 -25
  62. data/rdoc/lib/rdoc/markup/fragments.rb +0 -377
  63. data/rdoc/lib/rdoc/markup/inline.rb +0 -126
  64. data/rdoc/lib/rdoc/markup/lines.rb +0 -156
  65. data/rdoc/lib/rdoc/markup/preprocess.rb +0 -80
  66. data/rdoc/lib/rdoc/markup/to_flow.rb +0 -211
  67. data/rdoc/lib/rdoc/markup/to_html.rb +0 -406
  68. data/rdoc/lib/rdoc/markup/to_html_crossref.rb +0 -140
  69. data/rdoc/lib/rdoc/markup/to_latex.rb +0 -328
  70. data/rdoc/lib/rdoc/markup/to_test.rb +0 -53
  71. data/rdoc/lib/rdoc/markup/to_texinfo.rb +0 -73
  72. data/rdoc/lib/rdoc/markup.rb +0 -378
  73. data/rdoc/lib/rdoc/meta_method.rb +0 -8
  74. data/rdoc/lib/rdoc/normal_class.rb +0 -18
  75. data/rdoc/lib/rdoc/normal_module.rb +0 -34
  76. data/rdoc/lib/rdoc/options.rb +0 -542
  77. data/rdoc/lib/rdoc/parser/c.rb +0 -678
  78. data/rdoc/lib/rdoc/parser/perl.rb +0 -165
  79. data/rdoc/lib/rdoc/parser/ruby.rb +0 -2904
  80. data/rdoc/lib/rdoc/parser/simple.rb +0 -39
  81. data/rdoc/lib/rdoc/parser.rb +0 -138
  82. data/rdoc/lib/rdoc/rdoc.rb +0 -375
  83. data/rdoc/lib/rdoc/require.rb +0 -32
  84. data/rdoc/lib/rdoc/ri/cache.rb +0 -187
  85. data/rdoc/lib/rdoc/ri/descriptions.rb +0 -156
  86. data/rdoc/lib/rdoc/ri/display.rb +0 -340
  87. data/rdoc/lib/rdoc/ri/driver.rb +0 -828
  88. data/rdoc/lib/rdoc/ri/formatter.rb +0 -654
  89. data/rdoc/lib/rdoc/ri/paths.rb +0 -93
  90. data/rdoc/lib/rdoc/ri/reader.rb +0 -106
  91. data/rdoc/lib/rdoc/ri/util.rb +0 -79
  92. data/rdoc/lib/rdoc/ri/writer.rb +0 -68
  93. data/rdoc/lib/rdoc/ri.rb +0 -8
  94. data/rdoc/lib/rdoc/single_class.rb +0 -8
  95. data/rdoc/lib/rdoc/stats.rb +0 -178
  96. data/rdoc/lib/rdoc/task.rb +0 -276
  97. data/rdoc/lib/rdoc/tokenstream.rb +0 -33
  98. data/rdoc/lib/rdoc/top_level.rb +0 -242
  99. data/rdoc/lib/rdoc.rb +0 -398
@@ -1,152 +0,0 @@
1
- require 'rdoc'
2
-
3
- ##
4
- # We contain the common stuff for contexts (which are containers) and other
5
- # elements (methods, attributes and so on)
6
-
7
- class RDoc::CodeObject
8
-
9
- ##
10
- # Our comment
11
-
12
- attr_reader :comment
13
-
14
- ##
15
- # Do we document our children?
16
-
17
- attr_reader :document_children
18
-
19
- ##
20
- # Do we document ourselves?
21
-
22
- attr_reader :document_self
23
-
24
- ##
25
- # Are we done documenting (ie, did we come across a :enddoc:)?
26
-
27
- attr_accessor :done_documenting
28
-
29
- ##
30
- # Force documentation of this CodeObject
31
-
32
- attr_accessor :force_documentation
33
-
34
- ##
35
- # Our parent CodeObject
36
-
37
- attr_accessor :parent
38
-
39
- ##
40
- # Which section are we in
41
-
42
- attr_accessor :section
43
-
44
- ##
45
- # We are the model of the code, but we know that at some point we will be
46
- # worked on by viewers. By implementing the Viewable protocol, viewers can
47
- # associated themselves with these objects.
48
-
49
- attr_accessor :viewer
50
-
51
- ##
52
- # There's a wee trick we pull. Comment blocks can have directives that
53
- # override the stuff we extract during the parse. So, we have a special
54
- # class method, attr_overridable, that lets code objects list those
55
- # directives. When a comment is assigned, we then extract out any matching
56
- # directives and update our object
57
-
58
- def self.attr_overridable(name, *aliases)
59
- @overridables ||= {}
60
-
61
- attr_accessor name
62
-
63
- aliases.unshift name
64
-
65
- aliases.each do |directive_name|
66
- @overridables[directive_name.to_s] = name
67
- end
68
- end
69
-
70
- ##
71
- # Creates a new CodeObject that will document itself and its children
72
-
73
- def initialize
74
- @comment = nil
75
- @document_children = true
76
- @document_self = true
77
- @done_documenting = false
78
- @force_documentation = false
79
- @parent = nil
80
- end
81
-
82
- ##
83
- # Replaces our comment with +comment+, unless it is empty.
84
-
85
- def comment=(comment)
86
- @comment = comment unless comment.empty?
87
- end
88
-
89
- ##
90
- # Enables or disables documentation of this CodeObject's children. Calls
91
- # remove_classes_and_modules when disabling.
92
-
93
- def document_children=(document_children)
94
- @document_children = document_children
95
- remove_classes_and_modules unless document_children
96
- end
97
-
98
- ##
99
- # Enables or disables documentation of this CodeObject. Calls
100
- # remove_methods_etc when disabling.
101
-
102
- def document_self=(document_self)
103
- @document_self = document_self
104
- remove_methods_etc unless document_self
105
- end
106
-
107
- ##
108
- # File name of our parent
109
-
110
- def parent_file_name
111
- @parent ? @parent.base_name : '(unknown)'
112
- end
113
-
114
- ##
115
- # Name of our parent
116
-
117
- def parent_name
118
- @parent ? @parent.full_name : '(unknown)'
119
- end
120
-
121
- ##
122
- # Callback called upon disabling documentation of children. See
123
- # #document_children=
124
-
125
- def remove_classes_and_modules
126
- end
127
-
128
- ##
129
- # Callback called upon disabling documentation of ourself. See
130
- # #document_self=
131
-
132
- def remove_methods_etc
133
- end
134
-
135
- ##
136
- # Enable capture of documentation
137
-
138
- def start_doc
139
- @document_self = true
140
- @document_children = true
141
- end
142
-
143
- ##
144
- # Disable capture of documentation
145
-
146
- def stop_doc
147
- @document_self = false
148
- @document_children = false
149
- end
150
-
151
- end
152
-
@@ -1,23 +0,0 @@
1
- # We represent the various high-level code constructs that appear in Ruby
2
- # programs: classes, modules, methods, and so on.
3
-
4
- require 'rdoc/code_object'
5
- require 'rdoc/context'
6
- require 'rdoc/top_level'
7
-
8
- require 'rdoc/class_module'
9
- require 'rdoc/normal_class'
10
- require 'rdoc/normal_module'
11
- require 'rdoc/anon_class'
12
- require 'rdoc/single_class'
13
-
14
- require 'rdoc/any_method'
15
- require 'rdoc/alias'
16
- require 'rdoc/ghost_method'
17
- require 'rdoc/meta_method'
18
-
19
- require 'rdoc/attr'
20
- require 'rdoc/constant'
21
- require 'rdoc/require'
22
- require 'rdoc/include'
23
-
@@ -1,36 +0,0 @@
1
- require 'rdoc/code_object'
2
-
3
- ##
4
- # A constant
5
-
6
- class RDoc::Constant < RDoc::CodeObject
7
-
8
- ##
9
- # The constant's name
10
-
11
- attr_accessor :name
12
-
13
- ##
14
- # The constant's value
15
-
16
- attr_accessor :value
17
-
18
- ##
19
- # Creates a new constant with +name+, +value+ and +comment+
20
-
21
- def initialize(name, value, comment)
22
- super()
23
- @name = name
24
- @value = value
25
- self.comment = comment
26
- end
27
-
28
- ##
29
- # Path to this constant
30
-
31
- def path
32
- "#{@parent.path}##{@name}"
33
- end
34
-
35
- end
36
-