yard-markdown 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b8294ee2ef9bdd12b36f03b4260286e34d2002363a4f9cd280af85743c342c
-  data.tar.gz: f8df2867ca6d8c98aa79a20585d181b79ed12a507637b948708010ae2930ffe4
+  metadata.gz: c1c4368b70ec91bff1a8f9bf1aaefc79578a34251b879d800f59c466b611dd5a
+  data.tar.gz: 917397c1e9df43930d699fe0258dd124260b5168222fc28c5d0a84ded9f21d1e
 SHA512:
-  metadata.gz: 5d814cb9ac75d6330b72bbd53087fbc417392aa44296944da168f4195b7d92a9d60ff5e5e40d233ad628763c2c7d9cdb9c99213dde740dd54478791fce1bdacd
-  data.tar.gz: 1aba7f70acf91dca5f5b2a829160ff255a60a598360ccfce492d6cd2096a3d110095fb1eac6bf38138fab808ed98cc6b8b517598acd71a69cc658e235b47012e
+  metadata.gz: 932de039cf4fbd5fadd8bf012f7663f6cda4b270100b7930a28d6e182949628b727705a47893daebb5b39cf4c630f5c3a4e2f7a8ff3e7609e2aa2a43172db00f
+  data.tar.gz: 1d8191d7f0e0db8eea07842025a3dea14a924a67924464df8053ad00d337c9efb71ca832cafd3b83c2e6d150fa897c3ca08527744e86e043d4f3bd059db54898

data/example/Aquatic.md

@@ -4,6 +4,11 @@
 
 A mixin for aquatic creatures.
 
+
+| Constants | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |
 # Public Instance Methods
 ## swim() [](#method-i-swim)
 Swim in the water.
@@ -11,8 +16,3 @@ Swim in the water.
 **@return** [void] 
 
 
-# Constants
-| Name | Default Value |
-| ---  | ---   |
-| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
-| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/example/Fish.md

@@ -5,29 +5,34 @@
 
 The base class for all fish.
 
+
+| Constants | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |
 # Public Instance Methods
 ## make_sound() [](#method-i-make_sound)
 Make a sound.
 
 **@return** [void] 
+
 **@yield** [sound] The sound produced by the fish
+
 **@yieldparam** [String] The actual sound
+
 ## swim(direction, speed) [](#method-i-swim)
 Swim in a specific direction.
 
 Swimming is the most critical feature of fish.
 
 **@param** [Symbol, String] The direction to swim
+
 **@param** [Integer] The speed at which to swim
+
 **@return** [Boolean] Whether the swim was successful
 
+
 **@example**
 ```ruby
 swim(:north, 30)
 ```
-
-# Constants
-| Name | Default Value |
-| ---  | ---   |
-| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
-| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/example/Salmon.md

@@ -15,28 +15,41 @@ A salmon is an Aquatic Fish.
 *   **Aquatic**
     *   swim (overridden)
 
+
+| Constants | Default Value |
+| ---  | ---   |
+| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
+| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |
 # Public Instance Methods
 ## initialize(farmed, wild) [](#method-i-initialize)
 Creates a new salmon.
 
 **@param** [Boolean] Whether the salmon is farmed
+
 **@param** [Boolean] Whether the salmon is wild
+
 **@return** [Salmon] a new instance of Salmon
+
 ## make_sound() [](#method-i-make_sound)
 Salmon overrides generic implementation.
 
 **@return** [void] 
+
 **@yield** [sound] The sound produced by the salmon
+
 **@yieldparam** [String] The actual sound
+
 ## sustainable?() [](#method-i-sustainable?)
 Checks if this salmon is sustainable.
 
 **@return** [Boolean] Whether the salmon is sustainable
+
 ## swim() [](#method-i-swim)
 Swim in the water.
 
 **@return** [void] 
 
+
 # Public Class Methods
 ## wild_salmon() [](#method-c-wild_salmon)
 **@return** [Array<Salmon>] List of all wild salmon
@@ -45,12 +58,8 @@ Swim in the water.
 ## farmed[RW] [](#attribute-i-farmed)
 
 **@return** [Boolean] True for farmed salmon
+
 ## wild[RW] [](#attribute-i-wild)
 
 **@return** [Boolean] True for wild salmon
 
-# Constants
-| Name | Default Value |
-| ---  | ---   |
-| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
-| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

data/templates/default/fulldoc/markdown/setup.rb

@@ -111,6 +111,15 @@ def serialize(object)
 <%= rdoc_to_md object.docstring %>
 
 <%= render_tags object %>
+
+<% if constant_listing.size > 0 %>
+<% groups(constant_listing, "Constants") do |list, name| %>
+<% if list.size > 0 %>
+| <%= name %> | Default Value |
+| ---  | ---   |
+<% list.each do |cnst| %>
+| [<%= cnst.name %>](#<%=aref(cnst)%>) | <%= cnst.value %> |
+<% end %><% end %><% end %><% end %>
 <% if (insmeths = public_instance_methods(object)).size > 0 %>
 # Public Instance Methods
 <% insmeths.each do |item| %>
@@ -134,16 +143,7 @@ def serialize(object)
 <%= rdoc_to_md item.docstring %>
 
 <%= render_tags item %>
-<% end %><% end %>
-<% if constant_listing.size > 0 %>
-<% groups(constant_listing, "Constants") do |list, name| %>
-# <%= name %>
-<% if list.size > 0 %>
-| Name | Default Value |
-| ---  | ---   |
-<% list.each do |cnst| %>
-| [<%= cnst.name %>](#<%=aref(cnst)%>) | <%= cnst.value %> |
-<% end %><% end %><% end %><% end %>',
+<% end %><% end %>',
       trim_mode: "<>",
     )
 
@@ -179,7 +179,7 @@ def render_tags(object)
   result = String.new("")
   object.tags.each do |tag|
     result << if !(tag.tag_name == "example")
-      "**@#{tag.tag_name}** [#{tag.types&.join(', ')}] #{tag.text}\n"
+      "**@#{tag.tag_name}** [#{tag.types&.join(', ')}] #{tag.text}\n\n"
     else
       ""
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov