yard-markdown 0.7.1 → 0.7.2

data/example/yard/Fish.md

@@ -1,25 +0,0 @@
-# Class Fish <a id="class-Fish"></a>
-
-**Inherits:** `Object`
-
-The base class for all fish.
-
-## Public Instance Methods
-### `make_sound()` <a id="method-i-make_sound"></a> <a id="make_sound-instance_method"></a>
-Make a sound.
-- **@return** [void]
-- **@yield** [sound] The sound produced by the fish
-- **@yieldparam** `sound` [String] The actual sound
-
-### `swim(direction, speed)` <a id="method-i-swim"></a> <a id="swim-instance_method"></a>
-Swim in a specific direction.
-
-Swimming is the most critical feature of fish.
-- **@param** `direction` [Symbol, String] The direction to swim
-- **@param** `speed` [Integer] The speed at which to swim
-- **@return** [Boolean] Whether the swim was successful
-
-**@example**
-```ruby
-swim(:north, 30)
-```

data/example/yard/Salmon.md

@@ -1,58 +0,0 @@
-# Class Salmon <a id="class-Salmon"></a>
-
-**Inherits:** `Fish`
-**Includes:** `Aquatic`
-
-A salmon is an Aquatic Fish.
-
-## Features
-
-*   **Fish**
-    *   make_sound
-    *   swim
-*   **Aquatic**
-    *   swim (overridden)
-
-## Constants
-### Salmon specific attributes
-#### `MAX_SPEED` <a id="constant-MAX_SPEED"></a> <a id="MAX_SPEED-constant"></a>
-- **@return** [Integer] Maximum speed for a swimming salmon
-### General
-#### `@@wild_salmon` <a id="classvariable--40-40wild_salmon"></a> <a id="@@wild_salmon-classvariable"></a>
-Global list of all wild salmon.
-
-Use for conservation efforts.
-
-## Attributes
-### Salmon specific attributes
-#### `farmed` [RW] <a id="attribute-i-farmed"></a> <a id="farmed-instance_method"></a>
-- **@return** [Boolean] True for farmed salmon
-
-#### `wild` [R] <a id="attribute-i-wild"></a> <a id="wild-instance_method"></a>
-- **@return** [Boolean] True for wild salmon
-
-## Public Class Methods
-### `wild_salmon()` <a id="method-c-wild_salmon"></a> <a id="wild_salmon-class_method"></a>
-- **@return** [Array<Salmon>] List of all wild salmon
-
-## Public Instance Methods
-### Fish overrides
-#### `make_sound()` <a id="method-i-make_sound"></a> <a id="make_sound-instance_method"></a>
-Salmon overrides generic implementation.
-- **@return** [void]
-- **@yield** [sound] The sound produced by the salmon
-- **@yieldparam** `sound` [String] The actual sound
-### General
-#### `initialize(farmed, wild)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
-Creates a new salmon.
-- **@param** `farmed` [Boolean] Whether the salmon is farmed
-- **@param** `wild` [Boolean] Whether the salmon is wild
-- **@return** [Salmon] a new instance of Salmon
-
-#### `sustainable?()` <a id="method-i-sustainable-3F"></a> <a id="sustainable?-instance_method"></a>
-Checks if this salmon is sustainable.
-- **@return** [Boolean] Whether the salmon is sustainable
-
-#### `swim()` <a id="method-i-swim"></a> <a id="swim-instance_method"></a>
-Swim in the water.
-- **@return** [void]

data/example/yard/index.csv

@@ -1,16 +0,0 @@
-name,type,path
-Aquatic,Module,Aquatic.md
-Aquatic.swim,Method,Aquatic.md#method-i-swim
-Fish,Class,Fish.md
-Fish.make_sound,Method,Fish.md#method-i-make_sound
-Fish.swim,Method,Fish.md#method-i-swim
-Salmon,Class,Salmon.md
-Salmon.MAX_SPEED,Constant,Salmon.md#constant-MAX_SPEED
-Salmon.@@wild_salmon,Constant,Salmon.md#classvariable--40-40wild_salmon
-Salmon.initialize,Method,Salmon.md#method-i-initialize
-Salmon.make_sound,Method,Salmon.md#method-i-make_sound
-Salmon.sustainable?,Method,Salmon.md#method-i-sustainable-3F
-Salmon.swim,Method,Salmon.md#method-i-swim
-Salmon.wild_salmon,Method,Salmon.md#method-c-wild_salmon
-Salmon.farmed,Attribute,Salmon.md#attribute-i-farmed
-Salmon.wild,Attribute,Salmon.md#attribute-i-wild

data/example_rdoc.rb

@@ -1,146 +0,0 @@
-##
-# === RDoc::Generator::Markdown example.
-#
-# This example employs various RDoc features to demonstrate
-# generator output.
-#
-# ---
-#
-# Links:
-#
-#  1. {Project Home Page}[https://github.com/skatkov/rdoc-markdown)
-#  2. {RDoc Documentation}[http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Markup.html]
-#
-
-##
-# A mixin for waterfowl creatures.
-module Waterfowl
-  # Swimming helper.
-  def swim
-    puts "swimming around"
-  end
-end
-
-##
-# The base class for all birds.
-class Bird
-  ##
-  # Produce some noise.
-  #--
-  # FIXME: maybe extract this to a base class +Animal+?
-  #++
-  def speak # :yields: text
-    puts "generic tweeting"
-    yield "tweet"
-    yield "tweet"
-  end
-
-  # Fly somewhere.
-  #
-  # Flying is the most critical feature of birds.
-  #
-  # :args: direction, velocity
-  #
-  # :call-seq:
-  #   Bird.fly(symbol, number) -> bool
-  #   Bird.fly(string, number) -> bool
-  #
-  # = Example
-  #
-  #   fly(:south, 70)
-  def fly(direction, velocity)
-    _fly_impl(direction, velocity)
-  end
-
-  def _fly_impl(_direction, _velocity) # :nodoc:
-    puts "flying away: direction=#{direction}, velocity=#{velocity}"
-  end
-end
-
-##
-# A duck is a Waterfowl Bird.
-#
-# Features:
-#
-#  bird::
-#
-#    * speak
-#    * fly
-#
-#  waterfowl::
-#
-#    * swim
-class Duck
-  extend Animal
-  include Waterfowl
-
-  # :section: Bird overrides
-
-  # Duck overrides generic implementation.
-  def speak
-    speech = quack
-    yield speech
-  end
-
-  # Implements quacking
-  def quack
-    "quack"
-  end
-
-  private :quack
-
-  # :section: Duck extensions
-
-  # True for domestic ducks.
-  attr_accessor :domestic
-
-  # True for rubber ducks.
-  attr_reader :rubber
-
-  MAX_VELOCITY = 130 # Maximum velocity for a flying duck.
-
-  ##
-  # Global list of all rubber ducks.
-  #
-  # Use when in trouble.
-  @@rubber_ducks = []
-
-  # @return [Array<Duck>] list of all rubber ducks
-  def self.rubber_ducks
-    @@rubber_ducks
-  end
-
-  # Creates a new duck.
-  #
-  # @param [Boolean] domestic
-  # @param [Boolean] rubber
-  def initialize(domestic, rubber)
-    @domestic = domestic
-    @rubber = rubber
-    @@rubber_ducks << self if rubber
-  end
-
-  # Checks if this duck is a useful one.
-  #
-  # :call-seq:
-  #   Bird.useful? -> bool
-  def useful?
-    @domestic || @rubber
-  end
-end
-
-# Default velocity for a flying duck.
-DEFAULT_DUCK_VELOCITY = 70
-DEFAULT_SPEED = 10 # Maximum speed for a swimming duck.
-
-# Default rubber duck.
-#
-# *Note:*
-#  Global variables are evil, but rubber ducks are worth it.
-$default_rubber_duck = Duck.new(false, true)
-
-# Domestic rubber duck.
-#
-# *Note:*
-#  This is weird... Thus not making it global.
-domestic_rubber_duck = Duck.new(true, true) # rubocop:disable Lint/UselessAssignment

data/example_yard.rb

@@ -1,145 +0,0 @@
-# A mixin for aquatic creatures.
-#
-module Aquatic
-  # Swim in the water.
-  #
-  # @return [void]
-  def swim
-    puts "swimming in the water"
-  end
-end
-
-# The base class for all fish.
-class Fish
-  # Make a sound.
-  #
-  # @yield [sound] The sound produced by the fish
-  # @yieldparam sound [String] The actual sound
-  # @return [void]
-  def make_sound
-    puts "generic bubbling"
-    yield "blub"
-    yield "blub"
-  end
-
-  # Swim in a specific direction.
-  #
-  # Swimming is the most critical feature of fish.
-  #
-  # @param direction [Symbol, String] The direction to swim
-  # @param speed [Integer] The speed at which to swim
-  # @return [Boolean] Whether the swim was successful
-  #
-  # @example
-  #   swim(:north, 30)
-  def swim(direction, speed)
-    _swim_impl(direction, speed)
-  end
-
-  private
-
-  # @!visibility private
-  def _swim_impl(direction, speed)
-    puts "swimming away: direction=#{direction}, speed=#{speed}"
-  end
-end
-
-# A salmon is an Aquatic Fish.
-#
-# ## Features
-#
-# - **Fish**
-#   - make_sound
-#   - swim
-# - **Aquatic**
-#   - swim (overridden)
-class Salmon < Fish
-  include Aquatic
-
-  # @!group Fish overrides
-
-  # Salmon overrides generic implementation.
-  #
-  # @yield [sound] The sound produced by the salmon
-  # @yieldparam sound [String] The actual sound
-  # @return [void]
-  def make_sound
-    sound = splash
-    yield sound
-  end
-
-  # Implements splashing
-  #
-  # @return [String] The splash sound
-  def splash
-    "splash"
-  end
-
-  private :splash
-
-  # @!endgroup
-
-  # @!group Salmon specific attributes
-
-  # @return [Boolean] True for farmed salmon
-  attr_accessor :farmed
-
-  # @return [Boolean] True for wild salmon
-  attr_reader :wild
-
-  # @return [Integer] Maximum speed for a swimming salmon
-  MAX_SPEED = 40
-
-  # @!endgroup
-
-  # Global list of all wild salmon.
-  #
-  # Use for conservation efforts.
-  @@wild_salmon = []
-
-  # @return [Array<Salmon>] List of all wild salmon
-  def self.wild_salmon
-    @@wild_salmon
-  end
-
-  # Creates a new salmon.
-  #
-  # @param farmed [Boolean] Whether the salmon is farmed
-  # @param wild [Boolean] Whether the salmon is wild
-  def initialize(farmed, wild)
-    @farmed = farmed
-    @wild = wild
-    @@wild_salmon << self if wild
-  end
-
-  # Checks if this salmon is sustainable.
-  #
-  # @return [Boolean] Whether the salmon is sustainable
-  def sustainable?
-    @wild || (@farmed && environmentally_friendly?)
-  end
-
-  private
-
-  # @return [Boolean] Whether farming practices are environmentally friendly
-  def environmentally_friendly?
-    # Implementation details...
-    true
-  end
-end
-
-# Default speed for a swimming salmon
-DEFAULT_SALMON_SPEED = 20
-
-#   Maximum depth for salmon habitat
-MAX_DEPTH = 500
-
-# Default wild salmon.
-#
-# @note Global variables should be used sparingly, but this is for demonstration.
-$default_wild_salmon = Salmon.new(false, true)
-
-# Farmed sustainable salmon.
-#
-# @note This is just a local variable for demonstration purposes.
-Salmon.new(true, false)

data/lib/yard/markdown/anchor_component_helper.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# Namespace for YARD extensions used by this gem.
-module YARD
-  # Shared helpers for rendering YARD objects as Markdown.
-  module Markdown
-    # Builds anchor-safe identifier fragments from arbitrary values.
-    module AnchorComponentHelper
-      # Encodes a value so it can be embedded safely in an HTML anchor id.
-      #
-      # @param value [Object] Raw anchor fragment to encode.
-      # @return [String] Anchor-safe identifier fragment.
-      def anchor_component(value)
-        value.to_s.each_char.map do |char|
-          char.match?(/[A-Za-z0-9_-]/) ? char : format("-%X", char.ord)
-        end.join
-      end
-    end
-  end
-end