YARD support for markup inside code sections?

10 views
Skip to first unread message

Rich Morin

unread,
Feb 18, 2017, 8:00:30 AM2/18/17
to YARD
Does YARD support markup inside code sections? That is, can it handle something like this:

# ... file markup ...

class FooClass
# ... class markup ...

def foo_method()
# ... method markup ...

...

I recall asking about this quite a while back, and it wasn't supported then.  Looking in the docs,
I see no indication that this support has been added. Please advise.

-r

Loren Segal

unread,
Feb 18, 2017, 11:44:23 PM2/18/17
to YARD
YARD parses all comment blocks but does not handle them all by default. You could write a plugin to handle custom comment block formats.

Hope that helps!

Loren
Reply all
Reply to author
Forward
0 new messages