Created
August 19, 2011 11:46
-
-
Save Quintus/1156638 to your computer and use it in GitHub Desktop.
RDoc -f option and RDOCOPT demonstration
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
√ quintus@ikarus => ~/Desktop/abc | |
$ echo $RDOCOPT | |
√ quintus@ikarus => ~/Desktop/abc | |
$ cat test.rb | |
#This is the Foo class. | |
class Foo | |
#This is the bar method. | |
def bar | |
puts "Hello, World!" | |
end | |
end | |
√ quintus@ikarus => ~/Desktop/abc | |
$ export RDOCOPT="-f hanna" | |
√ quintus@ikarus => ~/Desktop/abc | |
$ rdoc test.rb | |
Parsing sources... | |
100% [ 1/ 1] test.rb | |
Generating Hanna format into /home/quintus/Desktop/abc/doc... | |
Files: 1 | |
Classes: 1 (0 undocumented) | |
Modules: 0 (0 undocumented) | |
Constants: 0 (0 undocumented) | |
Attributes: 0 (0 undocumented) | |
Methods: 1 (0 undocumented) | |
Total: 2 (0 undocumented) | |
100.00% documented | |
Elapsed: 0.3s | |
√ quintus@ikarus => ~/Desktop/abc | |
$ rm -r doc | |
√ quintus@ikarus => ~/Desktop/abc | |
$ rdoc -f darkfish test.rb | |
invalid options: -f generator already set to hanna | |
(invalid options are ignored) | |
Parsing sources... | |
100% [ 1/ 1] test.rb | |
Generating Hanna format into /home/quintus/Desktop/abc/doc... | |
Files: 1 | |
Classes: 1 (0 undocumented) | |
Modules: 0 (0 undocumented) | |
Constants: 0 (0 undocumented) | |
Attributes: 0 (0 undocumented) | |
Methods: 1 (0 undocumented) | |
Total: 2 (0 undocumented) | |
100.00% documented | |
Elapsed: 0.2s | |
√ quintus@ikarus => ~/Desktop/abc | |
$ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment