rdoc

I have a program written in Ruby that uses multiple levels of inheritance. All of the parent classes have implemented methods that an object of a child class would use, but when I generate an rdoc for my program, the rdoc page for a child class only shows the methods for that specific class and no methods from the parent class. Does anyone know how to display inherited class methods in rdoc? I have looked through rdoc documentation and some websites and haven't been able to find an answer on whether this is possible. This is a good question, but I am not aware of any solution. In fact, when I

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 like rdoc and hide the source in a block that is collapsed by default. I thought that HTML_DYNAMIC_SECTIONS might let me do this, but alas, the changelog says that option only affects diagrams and graphs. Maybe I could do it by editing the LAYOUT_FILE ? Anyhow, smart people, how can I coerce Doxygen to generate collapsable code sections? ax. if includ[ing] the source for methods, etc, [...] makes the

I don't remember where I learned the !~ method of the String class. However I know it compares a string to a regex and check whether the string not match the regex. See my below example. C:\>irb irb(main):001:0> "abba" =~ /(\w)(\w)\2\1/i => 0 irb(main):002:0> "xxxx" =~ /(\w)(\w)\2\1/i => 0 irb(main):003:0> "asdf" =~ /(\w)(\w)\2\1/i => nil irb(main):004:0> "asdf" !~ /(\w)(\w)\2\1/i => true irb(main):005:0> "asdf" !~ /asdf/i => false irb(main):006:0> I want to find more information of the method but I can't find it in the rdoc of both String and Regexp . Anyone can give some help? Thanks. Since

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 the namespace of String . I've even seen the method alone, when the class is assumed/implied ( #split ). I understand that this is the way methods are identified in ri. Which came first? Is this to differentiate, for example, methods from fields? I've also heard that this helps differentiates instance methods from class methods. But where did this start? The difference indicates how you access

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 and all the ruby files in vendor directory (plugins etc..) How can I create rdoc documentation only for ruby classes, files in following directories app folder (all the models, controllers and views) config folder lib folder I added this to my Rakefile; RDoc::Task.new :rdoc do |rdoc| rdoc.main = "README.rdoc" rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb")