Reply to thread

Message: [QUOTE="Eric Hodel, post: 4632754"] this is file documentation this is class documentation this is method documentation This is not how RDoc works: $ find . -type f /lib/foo.rb $ rdoc . Parsing sources with 2 thread(s)... 100% [ 1/ 1] lib/foo.rb Generating Darkfish... Files: 1 Classes: 1 Modules: 0 Methods: 1 Elapsed: 0.0s $ ack 'My application' doc/index.html [no results] $ You need to specify --main to have content beyond the generic "This is the API documentation for 'RDoc Documentation'." show up in doc/ index.html. Usually this is done like this: $ find . -type f /lib/foo.rb /README $ cat README # =Your Application Documentation # # My application does this and that, and # much more ...... # # ==Subtile #1 # # xyzxyzxyz xyzxyzxyz xyzxy xyzxyzxyz x # xyzxyzxyz xyzxyzxyz xyzxyzxyz xyzxyzxy # xyzxyzxyz xyzx # $ rdoc . --main README [...] $ ack 'My application' doc/index.html My application does this and that, and much more .….. [/QUOTE]