yard Questions
1
Solved
Is there a way to comment methods defined with define_method in YardDoc?
I tried this:
%w(one two three).each do |type|
# The #{type} way
# @return [String] the #{type} way
define_method("#{ty...
Sneeze asked 9/2, 2015 at 15:19
1
I have a method like this
def self.import(file_name, opts = {})
which I'm trying to document with YARD. However this is a method which is 100% side effect (I know, I know, side effects, urgh!). ...
Vacuity asked 7/9, 2014 at 22:49
3
I'm just starting to use YARD for documenting my Rails app. I didn't specify any specific Markup handler, but I would have expected that `code` would be converted to code, which doesn't seem to hap...
2
Solved
I was enjoying using YARD a lot:
http://www.ootl.org/yard/
http://code.google.com/p/yardparser/
http://www.codeproject.com/KB/recipes/yard-tokenizer.aspx
I was able to construct fully fun...
Cythiacyto asked 6/12, 2009 at 23:32
0
I've written some using documentation for a ruby gem. I'm using yard to generate the ruby gem reference documentation from the ruby source, and I want yard to work with this other markdown document...
1
While looking at Yard documentation and examples sI found some tags prefixed by an exclamation mark.
I found working examples with and without exclamation marks and I wasn't able to spot the diffe...
Panada asked 30/7, 2014 at 14:46
1
Solved
I have a function documented like this:
##
# Searches for street names in the local address database. Returns a list
# of strings, or invokes the block for each result.
#
# @param [String, Hash] q...
1
Solved
For a basic Ruby method, I would provide YARD style doc for parameters in the following format.
# @param query [String] The search string to query.
# @param options [Hash] Optional search preferen...
Chicken asked 8/3, 2014 at 17:6
1
Solved
I am writing documentation for my ruby gem using YARD. In my gem, I have some code which follows this common ruby pattern where a module is included in a class, and that module not only adds instan...
Sutter asked 15/1, 2012 at 20:17
1
Solved
I'm writing my first gem which I'm documenting with YARD. I've made one of my classes have a constructor which expects a block which takes no arguments1.
YARD provides the @yield [params] descript...
2
Solved
How do you create a link to a ruby class method with YARD? Here is the yard documentation regarding links.
Linking to an instance method within the same namespace:
{#my_instance_method}
Which w...
Perdure asked 11/1, 2013 at 7:52
0
On the YARD readme, there is mention of raw data generated by YARD:
YARD also outputs documented objects as raw data (the dumped
Namespace) which can be reloaded to do generation at a lat...
Kuhl asked 12/12, 2012 at 20:30
1
Solved
I downloaded the ruby Twitter gem source code and am trying to generate the documentation using yard, which I installed via gem install yard. In the rakefile, I found the following, which I assume ...
1
When trying to generate YARD documentation for a service implemented with Rails, I get the following warning:
$ yardoc
[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin:
YARD::...
Ham asked 20/6, 2012 at 12:9
2
Solved
I'm using YARD to generate docs for my rails app with makrdown as the script parser. Most of the documentation features just work great right out of the box. However, I'd also like to document the ...
Soyuz asked 18/3, 2011 at 5:2
6
Solved
I'm using yard to generate the documenation of my project. Even thought the documentation can generated and so don't really need to be versionned, we decided to do so, because it makes it easier to...
1
Solved
I was trying to document some Ruby code using yardand even though I am doing exactly what is described here or here
# @param [Integer] the number of trials (>= 0)
# @param [Float] success proba...
Hydroquinone asked 3/7, 2012 at 13:27
2
Solved
I'm using YARD to document my project. YARD document attributes created with
attr_accessor :some_attribute
in a separate section "Instance Attribute Summary". Now I have another attribut...
Needless asked 28/9, 2011 at 12:25
1
Solved
I am looking for way to iterate over the registers of a yardoc @macro. I know you are able to use them in something like as follows:
class Post
include DataMapper::Resource
# @macro dm.property...
Polyphone asked 27/4, 2012 at 1:29
1
Solved
YARD allows me to specify types for method parameters and return values. As I really like to duck type it is nice to see that YARD also supports defining types by specifying methods they must suppo...
Outcry asked 3/2, 2012 at 10:2
1
Solved
If I want see documentation on my gems I can do:
yard server --gems
How can I see the documentation of Ruby's standard library?
2
Solved
I'm using YARD to document my code. I have a method that has an optional parameter with a default value. How do I notate that the parameter is optional and has a default value?
Example:
# Squares...
1
Solved
I've decided to convert the README file in a project of mine to markdown and have been using yard verify the documentation rendered out ok. So I installed rdiscount, changed README to README.md and...
2
Solved
I have a small library of code that I am documenting with YARD. When I run the yardoc command, it tells me:
Files: 40
Modules: 14 ( 0 undocumented)
Classes: 39 ( 0 undocumented)
Constants: 21 ( 4 ...
Adjoint asked 22/4, 2011 at 15:21
1
Solved
I'm currently switching from rdoc to yard for my ruby software documentaion.
In my doc I often reference some classes/modules from the comments, for instance :
## == Provides various utility fea...
© 2022 - 2024 — McMap. All rights reserved.