rdoc Questions
3
Solved
I'm looking for a good, solid reference for proper RDoc syntax. Recommendations? I can't seem to find anything that clearly shows:
How to document class methods and their parameters
How to docume...
6
Solved
I know it's possible to install a gem without the documentation, but unfortunately, I didn't for the first three months I used ruby. In that time, I managed to install a significant amount of gems,...
2
For example,
$ gem install netaddr
Fetching: netaddr-1.5.1.gem (100%)
Successfully installed netaddr-1.5.1
ERROR: While executing gem ... (NoMethodError)
undefined method `reset' for RDoc::TopLev...
1
I have a class that I create from a factory function like this:
Cake = MyProject.Struct(:type, :price)
In Yard, it's simply displayed along with my constants:
Cake =
Struct(:type, :price)
I ...
1
Solved
When I used Visual Studio I was used to inserting XML comments with just a few key presses at the beginning of the method definition (I think /// but it's been a while). Is there a way to insert an...
1
Solved
The official documentation indicates that I should be able to build documentation for my application using rake doc:app, but when I run the command in Rails 5 I get the following output:
bwerth@bw...
Eximious asked 22/4, 2016 at 22:49
2
Solved
I would like to generate a documentation to my rails (2.3.8) project. When I tried
rake doc:rails
rake doc:rerails
It creates documentation for all the classes including standard ruby classes a...
Pharyngoscope asked 2/9, 2011 at 6:32
2
I'm using yard to generate my documentation for Rails apps from an rdoc file. There are AngularJS documentation generators, but how could they be connected to generate one coherent document f...
Koblenz asked 2/8, 2015 at 16:59
2
Solved
I am creating internal documentation for a C++ project using Doxygen. I am having Doxygen include the source for methods, etc., but this makes the page kind of hard to scan. I'd like it to behave l...
Raising asked 21/10, 2009 at 19:4
3
Solved
I'm in the process of switching over a rubygem I maintain from RDoc to YARD documentation. However, there are some critical comments in the code that need to remain only in the code and should not ...
2
Solved
Want to see how an RDoc README file will look on Github before committing. How to run RDoc on a single file and preview the result in a browser?
3
Solved
I have just installed the RVM and I am reading The Well-Grounded Rubyist book. In the first chapter I am supposed to try ri String#upcase to view documentation on the upcase method, however I get a...
2
Solved
It seems a lot of libraries/plugins use this syntax:
def self.included(base) # :nodoc:
base.extend ClassMethods
end
Why is the :nodoc: part necessary?
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...
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
2
Solved
I have Ubuntu 11.10 and am using rvm with ruby 1.9.2. I followed this exactly to install Ruby: http://blog.sudobits.com/2011/10/27/how-to-install-ruby-on-rails-in-ubuntu-11-10/
I generate the docs...
2
Solved
I have some gems that don't have ri/rdoc files and I'd like to know if there is a way to install this rdoc files.
4
Solved
When I run
rake db:create
I receive this error
rake aborted!
no such file to load -- rdoc/task
(See full trace by running task with --trace)
Here is the --trace
/usr/lib/ruby/site_ruby/1.8/...
Voltz asked 19/10, 2011 at 18:46
1
Is it possible to use a readme.md file with a Rails project and have rdoc use it a the main page? I tried setting up my rake task as follows, but the index.html page that gets generated has a place...
Theophylline asked 27/11, 2012 at 13:11
3
I want to link to a documentation of a file in RDoc. but the only way I could do is with the following markup:
configuration.rb[link:files/configuration_rb.html]
I would like to do it in a bette...
Approachable asked 9/2, 2010 at 17:9
1
I have a client gem which I will distribute business clients via rubygems. Gem client has cca. dozen gem dependencies and when it is being installed it takes a long time to install it due to genera...
3
Solved
I like to use Textile or Markdown to write readme files for my projects, but when I generate the RDoc the readme file gets interpreted as RDoc and looks really horrible. Is there a way to make RDoc...
2
Solved
Experimenting with pushing my first gem to rubygems.org, and I'm trying to figure out how to generate online documentation for it. For most gems 'show' page, when I click the 'Documentation' link, ...
3
Solved
Whenever I install gems I see ri and rdoc follow. I know this is documentation but what is the difference between the two and how to use them?
1 Next >
© 2022 - 2024 — McMap. All rights reserved.