yard_doc_example 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb8e0f5d3654e7c8386194f578be191aa72dd7f9845c9443ca1e73e50ddf479c
+  data.tar.gz: e8fd51fb38b1fee78bd2f5d294e27c5b06d804f4f682f4097f7d55d56bb845e0
+SHA512:
+  metadata.gz: d31ff178a5cb88dc82c333ebd846bd97a21a45b3654e388fb1d30ee98bb51a95c6d7bd05a7c3a701329641d8610f1f0982bc48065a3ebbf85c7b5a5135cc7597
+  data.tar.gz: 4673a8dcf76360b264e453a880fa206248b324175a0751c2497903962e725e9d3c6dd0d22d5e2e9640a02a401016211c9692129daabd222a5542e205c2e31b51

data/lib/yard_doc_example.rb

@@ -0,0 +1,60 @@
+# Description of the module
+# @since 0.6.0
+module YardDocExample
+
+  # An old implementation, is replaced by {YardDocExample::MyOtherClass}
+  #
+  # @author Jane Doe
+  # @abstract
+  # @since 0.6.0
+  # @deprecated Use {MyOtherClass} instead
+  #
+  # @attr [String] attribute_name a full description of the attribute
+  # @attr_reader [Hash] name_readonly description of a readonly attribute
+  # @attr_writer [Array<String>] name_writeonly description of writeonly attribute
+  # @!attribute [r] count
+  #   @return [Number] the number of items
+  #
+  # @see https://rubydoc.info/gems/yard/file/docs/GettingStarted.md Getting Started guide with YARD
+  # @see https://www.rubydoc.info/gems/yard/file/docs/Tags.md YARD Tags
+  # @see https://gist.github.com/chetan/1827484 YARD cheat sheet
+  class MyClass
+    #
+    # @see http://example.com Description of URL
+    # @see MyOtherClass#do_something
+    #
+    # @deprecated Use {MyOtherClass#do_something} instead of this method because
+    #   that one is newer.
+    #
+    # @private
+    #
+    # @param [Array<String>] arr the arguments passed from input. This
+    #   array will be modified.
+    # @param arr2 [Array<String, Symbol>] the list of strings and symbols.
+    # @param [Hash] opts the options to create a message with.
+    # @option opts [String] :subject The subject
+    # @option opts [String] :from ('nobody') From address
+    # @option opts [String] :to Recipient email
+    # @option opts [String] :body ('') The body
+    #
+    # Some code snippet:
+    #   MyClass.new.do_something
+    #
+    # @example Do someting
+    #   MyClass.new.do_something
+    #
+    # @raise [RuntimeError] description
+    #
+    # @return [String, nil] the successful result or nil
+    #   if an error occurred
+    def do_something(arr, arr2, opts:)
+    end
+  end
+
+  class MyOtherClass
+    # @todo implement me
+    #   should do much better than last time
+    def do_something
+    end
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: yard_doc_example
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dapeng Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-22 00:00:00.000000000 Z
+dependencies: []
+description: An example of using YARD
+email: dapeng@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard_doc_example.rb
+homepage: https://rubygems.org/gems/yard_doc_example
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An example of using YARD
+test_files: []