yard-markdown 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/example/Bird.md +6 -7
- data/example/Duck.md +5 -6
- data/example/Waterfowl.md +4 -5
- data/example/index.csv +3 -0
- data/example.rb +2 -0
- data/templates/default/fulldoc/markdown/setup.rb +3 -5
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 336637063b30cdb36819afce2e0380f467c1763ebbb022b006317488edebe134
|
|
4
|
+
data.tar.gz: 73692c82e184b6e3b7259af0ba1ce74fea209b71a56ed089c611ac0035415bbd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e9b0c05b3cfef30f77040ea8542091dd99231cece58f912079c0e356042bfe99fbfd4aad80e509bdad0390f07cc23d0a4be133db8d4c67e33981556cea87bbfd
|
|
7
|
+
data.tar.gz: c32c66c335f301dcaec541401b7d1276267aa5054b29574f70d8d1697680dddae6d649b044ce934df88ee4372efbbe2cb45e9eb6570aea6b0a465f77c91e57a4
|
data/example/Bird.md
CHANGED
|
@@ -4,18 +4,17 @@
|
|
|
4
4
|
| **Inherits:** | Object |
|
|
5
5
|
| **Defined in:** | example.rb |
|
|
6
6
|
|
|
7
|
-
|
|
8
7
|
The base class for all birds.
|
|
9
|
-
|
|
10
8
|
# Constants
|
|
11
|
-
## DEFAULT_DUCK_VELOCITY
|
|
12
|
-
|
|
13
|
-
|
|
9
|
+
## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
|
|
10
|
+
Default velocity for a flying duck.
|
|
11
|
+
## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
|
|
12
|
+
Maximum speed for a swimming duck.
|
|
14
13
|
|
|
15
14
|
# Public Instance Methods
|
|
16
|
-
## _fly_impl(_direction
|
|
15
|
+
## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
|
|
17
16
|
:nodoc:
|
|
18
|
-
## fly(direction
|
|
17
|
+
## fly(direction, velocity) [](#method-i-fly)
|
|
19
18
|
Fly somewhere.
|
|
20
19
|
|
|
21
20
|
Flying is the most critical feature of birds.
|
data/example/Duck.md
CHANGED
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
| **Includes:** | Waterfowl |
|
|
7
7
|
| **Defined in:** | example.rb |
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
A duck is a Waterfowl Bird.
|
|
11
10
|
|
|
12
11
|
Features:
|
|
@@ -19,14 +18,14 @@ Features:
|
|
|
19
18
|
waterfowl::
|
|
20
19
|
|
|
21
20
|
* swim
|
|
22
|
-
|
|
23
21
|
# Constants
|
|
24
|
-
## DEFAULT_DUCK_VELOCITY
|
|
25
|
-
|
|
26
|
-
|
|
22
|
+
## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
|
|
23
|
+
Default velocity for a flying duck.
|
|
24
|
+
## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
|
|
25
|
+
Maximum speed for a swimming duck.
|
|
27
26
|
|
|
28
27
|
# Public Instance Methods
|
|
29
|
-
## initialize(domestic
|
|
28
|
+
## initialize(domestic, rubber) [](#method-i-initialize)
|
|
30
29
|
Creates a new duck.
|
|
31
30
|
## speak() [](#method-i-speak)
|
|
32
31
|
Duck overrides generic implementation.
|
data/example/Waterfowl.md
CHANGED
|
@@ -3,13 +3,12 @@
|
|
|
3
3
|
| -----------------: | :----- |
|
|
4
4
|
| **Defined in:** | example.rb |
|
|
5
5
|
|
|
6
|
-
|
|
7
6
|
A mixin for waterfowl creatures.
|
|
8
|
-
|
|
9
7
|
# Constants
|
|
10
|
-
## DEFAULT_DUCK_VELOCITY
|
|
11
|
-
|
|
12
|
-
|
|
8
|
+
## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
|
|
9
|
+
Default velocity for a flying duck.
|
|
10
|
+
## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
|
|
11
|
+
Maximum speed for a swimming duck.
|
|
13
12
|
|
|
14
13
|
# Public Instance Methods
|
|
15
14
|
## swim() [](#method-i-swim)
|
data/example/index.csv
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
name,type,path
|
|
2
2
|
Waterfowl,Module,Waterfowl.md
|
|
3
3
|
DEFAULT_DUCK_VELOCITY,Constant,Waterfowl.md#constant-DEFAULT_DUCK_VELOCITY
|
|
4
|
+
DEFAULT_SPEED,Constant,Waterfowl.md#constant-DEFAULT_SPEED
|
|
4
5
|
swim,Method,Waterfowl.md#method-i-swim
|
|
5
6
|
Bird,Class,Bird.md
|
|
6
7
|
DEFAULT_DUCK_VELOCITY,Constant,Bird.md#constant-DEFAULT_DUCK_VELOCITY
|
|
8
|
+
DEFAULT_SPEED,Constant,Bird.md#constant-DEFAULT_SPEED
|
|
7
9
|
_fly_impl,Method,Bird.md#method-i-_fly_impl
|
|
8
10
|
fly,Method,Bird.md#method-i-fly
|
|
9
11
|
speak,Method,Bird.md#method-i-speak
|
|
10
12
|
Duck,Class,Duck.md
|
|
11
13
|
DEFAULT_DUCK_VELOCITY,Constant,Duck.md#constant-DEFAULT_DUCK_VELOCITY
|
|
14
|
+
DEFAULT_SPEED,Constant,Duck.md#constant-DEFAULT_SPEED
|
|
12
15
|
initialize,Method,Duck.md#method-i-initialize
|
|
13
16
|
speak,Method,Duck.md#method-i-speak
|
|
14
17
|
swim,Method,Duck.md#method-i-swim
|
data/example.rb
CHANGED
|
@@ -108,25 +108,23 @@ def serialize(object)
|
|
|
108
108
|
| **Defined in:** | <%= object.file ? object.file : "(unknown)" %> |
|
|
109
109
|
<% end %>
|
|
110
110
|
|
|
111
|
-
|
|
112
111
|
<%= object.docstring %>
|
|
113
112
|
|
|
114
|
-
|
|
115
113
|
<% if constant_listing.size > 0 %>
|
|
116
114
|
<% groups(constant_listing, "Constants") do |list, name| %>
|
|
117
115
|
# <%= name %>
|
|
118
116
|
<% list.each do |cnst| %>
|
|
119
|
-
## <%= cnst.name %>
|
|
117
|
+
## <%= cnst.name %> [](#<%=aref(cnst)%>)
|
|
120
118
|
<%= cnst.docstring %>
|
|
119
|
+
|
|
121
120
|
<% end %>
|
|
122
121
|
<% end %>
|
|
123
|
-
|
|
124
122
|
<% end %>
|
|
125
123
|
|
|
126
124
|
<% if (insmeths = public_instance_methods(object)).size > 0 %>
|
|
127
125
|
# Public Instance Methods
|
|
128
126
|
<% insmeths.each do |item| %>
|
|
129
|
-
## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("
|
|
127
|
+
## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("") }.join(", ")%>) [](#<%=aref(item)%>)
|
|
130
128
|
<%= item.docstring %>
|
|
131
129
|
|
|
132
130
|
<% end %>
|