YARD support for Hashie::Dash?

[maxlinc]

It would be cool if YARD could generate docs for Hashie::Dash, at a basic list of attributes defined via property.

I created a gist based on the YARD guide for writing handlers, the source for YARD::Handlers::Ruby::AttributeHandler and a few similar handlers I found.

It seems to work, but I haven't completely figured out:

• The AST, to see if I can handle the :default, or :required properties.
• Trying to scope the handler so it only applies on classes that are a Hashie::Dash (if that's possible)
• If there is a way to package the handler in a way that it's automatically used by http://rubydoc.info/.

[maxlinc]

BTW - here's example source and generated doc, similar to attribute:

class MyDash < Hashie::Dash
  property :one
  property :two, required: true
  property :three, default: 3, required: true
end

[michaelherold]

@maxlinc Have you looked into this any further? I think it looks like a nice-to-have feature but I haven't ever worked with YARD handlers.

[maxlinc]

@michaelherold I haven't played with it much more, but I have used macros to more easily generate documentation.

Macros were useful, but probably not ideal:

• I'm not sure if macros can be defined in a gem
• There isn't a real way to process the options. So I was creating more specific wrapper methods like required_property and optional_property rather than having a macro that understood property :foo, required: true.

Anyways - I think it would be nice but if it's going to happen it looks like it should be a separate yard-hashie gem, because that's how yard plugins generally work. And also because @lsegal needs to review the plugin if it's going to be enabled on rubydoc.info.

[lsegal]

Hi there. Macros can be defined in a gem!