rdoc
how do I process a readme file with rdoc to display ruby script help/usage info
I\'d like to keep my usage documenation in a readme file (duh) instead of comments at the top of my script.How do I get RDoc::usage to pull the usage information out of the readme instead of the开发者[详细]
2023-01-25 13:49 分类:问答rdoc, darkfish, and the :call-seq: tag
I\'m in the process of documenting a Ruby project with rdoc, and I discovered the darkfish rdoc formatter.I really like it, but the :call-seq: tag no longer works.Instead, it puts the literal string :[详细]
2023-01-19 20:20 分类:问答Is there a good, solid reference for proper RDoc syntax?
I\'m l开发者_JAVA技巧ooking for a good, solid reference for proper RDoc syntax. Recommendations? I can\'t seem to find anything that clearly shows:[详细]
2023-01-19 01:32 分类:问答Simple Rdoc Question about documentation modifiers
I have this method in a class I am using def binary_search(a,x) # ... end and I want in the documentation for the parameters to appear as def binary_search(array, key) and not binary_search(a,x). I[详细]
2023-01-17 09:05 分类:问答Accessing rdoc files from one place
In Ruby, if you run the command gem server it will present you with a web page of documentation for all the gems you have installed on your machine. Can something similar be done for your local docume[详细]
2023-01-16 23:03 分类:问答Cannot find a class
You can use Octopussy like this: Octopussy.user \"my_account\" But I cannot find the \"user\" method in the API documentation http://rdoc.info/github/pengwynn/octopussy开发者_开发百科/master/Octopu[详细]
2023-01-15 23:17 分类:问答When running rdoc the folders 'images' and 'js' are not copied to the doc dir
I am running rdoc 2.5.9 and when I generate rdoc with the default \'Darkfish\' template just by running:[详细]
2023-01-11 02:07 分类:问答What's the rationale/history for the # convention of identifying methods in Ruby?
For example, I\'ve always seen methods referred to as String#split, but never String.split, which seems slightly more logical.Or maybe even String::split, because you could consider #split to be in th[详细]
2023-01-05 06:40 分类:问答Problems installing rdoc, irb, bluecloth, chronic on fedora 12
What do these errors mean? [root@localhost config]# 开发者_如何学Gogem install bluecloth Building native extensions.This could take a while...[详细]
2023-01-01 11:03 分类:问答How can I document implicit methods inside of rails models?
I\'m using YARD on my Rails project and was wondering how I would go about documen开发者_JS百科ting inherited/runtime methods on a Rails model? For instance documenting the existence of a first_name a[详细]
2022-12-30 23:34 分类:问答