yard-markdown 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/example/Bird.md +12 -27
  3. data/example/Duck.md +21 -46
  4. data/example/Waterfowl.md +8 -19
  5. data/templates/default/fulldoc/markdown/setup.rb +20 -26
  6. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0282033a919774b5cd92979a1291cda4ed834c27cbfc21ca231982475aefa6cf'
4
- data.tar.gz: ade62aa4bc7c6091cbdc229bebf16ec77f753bba17e0ab0e0ef0fe28527838a9
3
+ metadata.gz: c6a31bd0b9314cb81e288f61c6f923ad3b8b5708ae1776ca0728fc9e0e8b3a07
4
+ data.tar.gz: 83f19bcda05228295f943c1cb09cde16dc6738c60e96a7194eade9f15597c17e
5
5
  SHA512:
6
- metadata.gz: 8604ca85cdc4e6486b00e94a694fa35661dc06c9042882e41afe9e41fa863d582173473b8fbc8e1edb8e08db8908ab26bc887c4773465c8d94c04c6c72992366
7
- data.tar.gz: bbf3e68cd55b9ead82fbe0307d106e7e31a284fbb567eadb3bf6ab08c4b2ba1523699629950e7d85124216da3c94f114220e3bf2c0857d5f0d2d088ca39d0074
6
+ metadata.gz: 3e4d2ecd151a91ba5085d86f398f592c71d2d0744f46487bb07969190f8070acdeb15841325dff7a8c1b96e651fbf375a4cb3c358b5032b1734cbcc8b988c7e8
7
+ data.tar.gz: 1713b22f373b5fc163202d2e51b9c6ff3fe4f502facba94eaa37e77874ae2222f6e3e9dd5f16e6630210870528fc68cfbd86956d2bb8da6bd8b16cb4efef3724
data/example/Bird.md CHANGED
@@ -5,16 +5,12 @@
5
5
 
6
6
  The base class for all birds.
7
7
 
8
+ # Public Instance Methods
9
+ ## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
10
+ :nodoc:
8
11
 
9
- # Public Instance Methods
10
-
11
- ## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
12
- :nodoc:
13
-
14
-
15
-
16
- ## fly(direction, velocity) [](#method-i-fly)
17
- Fly somewhere.
12
+ ## fly(direction, velocity) [](#method-i-fly)
13
+ Fly somewhere.
18
14
 
19
15
  Flying is the most critical feature of birds.
20
16
 
@@ -28,26 +24,15 @@ Flying is the most critical feature of birds.
28
24
 
29
25
  fly(:south, 70)
30
26
 
27
+ ## speak() [](#method-i-speak)
28
+ Produce some noise. -- FIXME: maybe extract this to a base class `Animal`? ++
31
29
 
32
-
33
- ## speak() [](#method-i-speak)
34
- Produce some noise. -- FIXME: maybe extract this to a base class `Animal`? ++
35
-
36
-
37
-
38
-
39
-
40
-
41
- # Constants
42
-
43
- ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
44
- Default velocity for a flying duck.
45
30
 
46
31
 
47
-
48
- ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
49
- Maximum speed for a swimming duck.
32
+ # Constants
33
+ ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
34
+ Default velocity for a flying duck.
50
35
 
36
+ ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
37
+ Maximum speed for a swimming duck.
51
38
 
52
-
53
-
data/example/Duck.md CHANGED
@@ -20,63 +20,38 @@ Features:
20
20
 
21
21
  * swim
22
22
 
23
+ # Public Instance Methods
24
+ ## initialize(domestic, rubber) [](#method-i-initialize)
25
+ Creates a new duck.
23
26
 
24
- # Public Instance Methods
25
-
26
- ## initialize(domestic, rubber) [](#method-i-initialize)
27
- Creates a new duck.
28
-
29
-
30
-
31
- ## speak() [](#method-i-speak)
32
- Duck overrides generic implementation.
33
-
34
-
35
-
36
- ## swim() [](#method-i-swim)
37
- Swimming helper.
27
+ ## speak() [](#method-i-speak)
28
+ Duck overrides generic implementation.
38
29
 
30
+ ## swim() [](#method-i-swim)
31
+ Swimming helper.
39
32
 
40
-
41
- ## useful?() [](#method-i-useful?)
42
- Checks if this duck is a useful one.
33
+ ## useful?() [](#method-i-useful?)
34
+ Checks if this duck is a useful one.
43
35
 
44
36
  :call-seq:
45
37
  Bird.useful? -> bool
46
38
 
47
39
 
48
-
49
-
50
- # Public Class Methods
51
-
52
- ## rubber_ducks() [](#method-c-rubber_ducks)
53
-
54
-
55
-
56
- # Attributes
57
-
58
- ## domestic[RW] [](#attribute-i-domestic)
59
- True for domestic ducks.
60
-
61
-
62
-
63
- ## rubber[RW] [](#attribute-i-rubber)
64
- True for rubber ducks.
65
-
66
-
67
-
40
+ # Public Class Methods
41
+ ## rubber_ducks() [](#method-c-rubber_ducks)
68
42
 
43
+ # Attributes
44
+ ## domestic[RW] [](#attribute-i-domestic)
45
+ True for domestic ducks.
69
46
 
70
- # Constants
71
-
72
- ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
73
- Default velocity for a flying duck.
47
+ ## rubber[RW] [](#attribute-i-rubber)
48
+ True for rubber ducks.
74
49
 
75
50
 
76
-
77
- ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
78
- Maximum speed for a swimming duck.
51
+ # Constants
52
+ ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
53
+ Default velocity for a flying duck.
79
54
 
55
+ ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
56
+ Maximum speed for a swimming duck.
80
57
 
81
-
82
-
data/example/Waterfowl.md CHANGED
@@ -4,27 +4,16 @@
4
4
 
5
5
  A mixin for waterfowl creatures.
6
6
 
7
+ # Public Instance Methods
8
+ ## swim() [](#method-i-swim)
9
+ Swimming helper.
7
10
 
8
- # Public Instance Methods
9
-
10
- ## swim() [](#method-i-swim)
11
- Swimming helper.
12
11
 
13
12
 
14
-
13
+ # Constants
14
+ ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
15
+ Default velocity for a flying duck.
15
16
 
17
+ ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
18
+ Maximum speed for a swimming duck.
16
19
 
17
-
18
- # Constants
19
-
20
- ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
21
- Default velocity for a flying duck.
22
-
23
-
24
-
25
- ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
26
- Maximum speed for a swimming duck.
27
-
28
-
29
-
30
-
data/templates/default/fulldoc/markdown/setup.rb CHANGED
@@ -106,45 +106,39 @@ def serialize(object)
106
106
 
107
107
  <%= rdoc_to_md object.docstring %>
108
108
 
109
-
110
109
  <% if (insmeths = public_instance_methods(object)).size > 0 %>
111
- # Public Instance Methods
112
- <% insmeths.each do |item| %>
113
- ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("") }.join(", ")%>) [](#<%=aref(item)%>)
114
- <%= rdoc_to_md item.docstring %>
110
+ # Public Instance Methods
111
+ <% insmeths.each do |item| %>
112
+ ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("") }.join(", ")%>) [](#<%=aref(item)%>)
113
+ <%= rdoc_to_md item.docstring %>
115
114
 
116
- <% end %>
117
- <% end %>
115
+ <% end %><% end %>
118
116
 
119
117
  <% if (pubmeths = public_class_methods(object)).size > 0 %>
120
- # Public Class Methods
121
- <% pubmeths.each do |item| %>
122
- ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
123
- <%= rdoc_to_md item.docstring %>
118
+ # Public Class Methods
119
+ <% pubmeths.each do |item| %>
120
+ ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
121
+ <%= rdoc_to_md item.docstring %>
124
122
 
125
- <% end %>
123
+ <% end %>
126
124
  <% end %>
127
125
  <% if (attrs = attr_listing(object)).size > 0 %>
128
- # Attributes
129
- <% attrs.each do |item|%>
130
- ## <%= item.name %><%= item.reader? ? "[RW]" : "[R]" %> [](#<%=aref(item)%>)
131
- <%= rdoc_to_md item.docstring %>
126
+ # Attributes
127
+ <% attrs.each do |item|%>
128
+ ## <%= item.name %><%= item.reader? ? "[RW]" : "[R]" %> [](#<%=aref(item)%>)
129
+ <%= rdoc_to_md item.docstring %>
132
130
 
133
- <% end %>
134
131
  <% end %>
135
-
132
+ <% end %>
136
133
 
137
134
  <% if constant_listing.size > 0 %>
138
135
  <% groups(constant_listing, "Constants") do |list, name| %>
139
- # <%= name %>
140
- <% list.each do |cnst| %>
141
- ## <%= cnst.name %> [](#<%=aref(cnst)%>)
142
- <%= rdoc_to_md cnst.docstring %>
136
+ # <%= name %>
137
+ <% list.each do |cnst| %>
138
+ ## <%= cnst.name %> [](#<%=aref(cnst)%>)
139
+ <%= rdoc_to_md cnst.docstring %>
143
140
 
144
- <% end %>
145
- <% end %>
146
- <% end %>
147
- ', trim_mode: "%<>")
141
+ <% end %><% end %><% end %>', trim_mode: "<>")
148
142
 
149
143
  template.result(binding)
150
144
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-markdown
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stanislav (Stas) Katkov