Any plan to support yard?

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. What's this mean? It means YARD is a great tool to document applications that make use of DSLs.    http://yardoc.org/docs/yard/file:docs/GettingStarted.md

From the document, and the defined annotations are very useful for code completion and navigation.

# Converts the object into textual markup given a specific format.
#
# @param [Symbol] format the format type, `:text` or `:html`
# @return [String] the object converted into the expected format.
def to_format(format = :html)
  # format the object
end
2 comments
Comment actions Permalink

Hello linux_china,

Could you please file a YouTrack issue? Looks like we do want to support
YARD in RubyMine 3.0.

YARD is a documentation generation tool for the Ruby programming
language. It enables the user to generate consistent, usable
documentation that can be exported to a number of formats very easily,
and also supports extending for custom Ruby constructs such as custom
class level definitions. What's this mean? It means YARD is a great
tool to document applications that make use of DSLs.
http://yardoc.org/docs/yard/file:docs/GettingStarted.md

From the document, and the defined annotations are very useful for
code completion and navigation.

  1. Converts the object into textual markup given a specific format.

#

  1. @param format the format type, `:text` or `:html`

  2. @return the object converted into the expected format.

def to_format(format = :html)

  1. format the object

end
---
Original message URL:
http://www.jetbrains.net/devnet/message/5252305#5252305

--
Dmitry Jemerov
Development Lead
JetBrains, Inc.
http://www.jetbrains.com/
"Develop with Pleasure!"


0

Please sign in to leave a comment.