@ms-ati YARD doesn't do any runtime analysis, and it would be near impossible for an IDE like IntelliJ to deterministically detect any of the above with or without YARD (specifically because IntelliJ could never guarantee that
Value.new is your library's Value class. That said, you can write a YARD plugin to generate whatever information you want in the registry, effectively treating it like a struct in the same way YARD does it: https://github.com/lsegal/yard/blob/master/lib/yard/handlers/ruby/class_handler.rb#L72 just don't expect any IDE integration even with that logic.
@lsegal IntelliJ/Rubymine extract type information from YARD tags (https://www.jetbrains.com/ruby/help/using-annotations.html#d903984e128). I had assumed, perhaps incorrectly, that they integrated with YARD to do this. But I realize now that they probably have their own parser for this.
I'm creating an instance of a DSL class, then adding a singleton method to it.
dsl_instance = DSLClass.new
def dsl_instance.a_callback_method
# code
endYard throws warnings. Anyway to doc the method? Thanks.
Also, I've created a replacement template system for YARD, still working on it. Example is at http://msp-greg.github.io/
Hi, what is the correct notation for putting
@example under list item? Output: http://www.rubydoc.info/github/bbatsov/RuboCop/RuboCop/Cop/Style/BracesAroundHashParameters Code: https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/cop/style/braces_around_hash_parameters.rb#L6
The link is to rubydoc, but it behaves same locally
You may not want to use example tags in that case, or use the header text in the form
@example DESCRIPTION TEXT
Generally though, it doesn't seem like you want to use example tags in that specific case. Those aren't usage examples of an API, those are just blocks of code related to your APIs functionality.
Hi, i hope i am right here. I started using yard to document sparkleformation (a ruby dsl). But something i can't find out is, if its possible to override the Class - my dsl has no classes, but i want to define the class of a method manuelly by overriding it - if its possible. Or - if not - can i remove the class group of the rendered html files?
Any chance of getting a way to document classes created as constants using the
values gem, such as Table = Value.new(:legs), as a class instead of like a normal constant? I've seen there were previous requests for this same feature for Structs, which would work analogously. A @!class directive perhaps?
@here is this alive?
@lsegal is there a way to make yard find methods that have undocumented parameters?
@lsegal in Ruby 3.0
**options may no longer be a hash - and even now that detail might be better off considered an implementation detail. I wonder if when a user writes **options we could explicitly mark it as "Keyword Arguments", for example. Anyway, just a discussion point that as we head towards Ruby 3.0, may become more important.
Oh, hello, I'm a user of YARD, and I'd be excited about having "comment suffix for
@see" support, so that my references to related methods could be described.
Right now it formats the entire text as a link which is a bit awkward.
Here's an illustration of the current workaround:
# @see Endpoint.udp udp - invoked when parsing a URL with the udp scheme: "udp://127.0.0.1" Note the repetition of the udp word.
# @param options keyword arguments passed straight through to {#initialize}
shouldn't we do one more sorting after this line? https://github.com/lsegal/yard/blob/master/lib/yard/parser/source_parser.rb#L111
something like
.sort_by! { |file_path| [file_path.count('/'), file_path] }
to make sure the files higher in hierarchy are actually first?
now when we have two files
/a/baaaaaaaaaaaaaa.rb and /a/b/a.rb the more nested will be actually first
so we should sort in a way, that will make the less nested files first despite their length
this should minimize the order churn as well