When an example has blank lines, each "chunk" becomes its own box:

The argument described here is not documented when documentation generated with yard-tomdoc
https://github.com/perplexes/m2r/blob/master/lib/m2r.rb#L20

http://rubyworks.github.io/yard-tomdoc/docs/YARD/index.html

gem install yard-tomdoc will install 0.3.0, because the 0.3.1 is called 'yad-tomdoc' on rubygems.

It seems that newlines are removed and spaces are messed up.

Code:

# Example
#
#   class Child
#     extend AccountInheritance
#
#     belongs_to :parent
#
#     inherits_account_from :parent
#   end

Result:

Need to have it recognize Returns nothing and pass that on correctly to YARD. Right now YARD reports Object as the return type.

It seems that yard-tomdoc parses only the first line of description and ignores params if description contains more than 1 paragraph:

  # Public: Some method.
  #
  # This is a longer description.
  #
  # id - The Integer id of tne campaign.
  #
  # Examples
  #
  #   puts "Hello world"
  #
  # Returns nothing

And the result is:

TomDoc recently add the signatures feature. So yard-tomdoc needs to add support for that,.

When running the yard script all my methods having the Internal: indicator in the description yields this error:

[error]: Unhandled exception in YARD::Handlers::Ruby::MethodHandler

Using:

* yard (0.7.5)
* yard-tomdoc (0.4.0 f3e9e3d)

Hi, I am trying to get this gem working, but I have no luck.

• This is in my example.rb file:

    class Example
      # Public: Duplicate some text an arbitrary number of times.
      #
      # text  - The String to be duplicated.
      # count - The Integer number of times to duplicate the text.
      #
      # Examples
      #
      #   multiplex('Tom', 4)
      #   # => 'TomTomTomTom'
      #
      # Returns the duplicated String.
      def multiplex(text, count)
        text * count
      end
    end

• I have yard (0.8.2.1) and yard-tomdoc gems installed. Then I run yard --debug --plugin yard-tomdoc example.rb and the result is

[debug]: Parsing ["example.rb"] with `ruby` parser
[debug]: Parsing example.rb
[debug]: Serializing to .yardoc/objects/root.dat
[debug]: Re-generating object ...
[debug]: Re-generating object Example...
[debug]: Generating asset js/jquery.js
[debug]: Serializing to doc/js/jquery.js
[debug]: Generating asset js/app.js
[debug]: Serializing to doc/js/app.js
[debug]: Generating asset js/full_list.js
[debug]: Serializing to doc/js/full_list.js
[debug]: Generating asset css/style.css
[debug]: Serializing to doc/css/style.css
[debug]: Generating asset css/common.css
[debug]: Serializing to doc/css/common.css
[debug]: Generating asset css/full_list.css
[debug]: Serializing to doc/css/full_list.css
[debug]: Generating asset class_list.html
[debug]: Serializing to doc/class_list.html
[debug]: Generating asset method_list.html
[debug]: Serializing to doc/method_list.html
[debug]: Generating asset file_list.html
[debug]: Serializing to doc/file_list.html
[debug]: Generating asset frames.html
[debug]: Serializing to doc/frames.html
[debug]: Serializing to doc/_index.html
[debug]: Serializing to doc/index.html
[debug]: Serializing to doc/file.README.html
[debug]: Serializing to doc/top-level-namespace.html
[debug]: Serializing to doc/Example.html
Files:           1
Modules:         0 (    0 undocumented)
Classes:         1 (    1 undocumented)
Constants:       0 (    0 undocumented)
Methods:         1 (    0 undocumented)
 50.00% documented

• Generated example.html looks like this:
  
• I think it's ignoring Parameters and Returns.

All versions of the loaded gem have been yanked https://rubygems.org/gems/loaded. This is a dependency for yard-tomdoc.

Not sure where the best place is to ask this question—apologies if using an Issue was inappropriate.

Is it possible for me to document methods defined by macros in TomDoc. For example, Rails's delegate method.

class Person < ActiveRecord::Base

  ##
  # The project this person is associated with
  # Returns a Project
  belongs_to :project

  ##
  # The name of the {Project} this person is associated with.
  #
  # Returns a String
  delegate :name, to: :project, prefix: true

end

If I do the above, the documentation incorrectly reports the delegated method name as simply name, without the project_ prefix.

Is there another way?

If a doc has nothing but a description, or more specifically, if it has no Returns specified, then see if there is a [Foo] notation tacked on to the end of the description, and use that. This would be very helpul for attributes, e.g.

# The files to use.  [Array<String>]
attr :files

When running the yard script all my methods having the Internal: indicator in the description yields this error:

[error]: Unhandled exception in YARD::Handlers::Ruby::MethodHandler

Using:

* yard (0.7.5)
* yard-tomdoc (0.4.0 f3e9e3d)