diff options
Diffstat (limited to 'lib/rdoc')
| -rw-r--r-- | lib/rdoc/README | 4 | ||||
| -rw-r--r-- | lib/rdoc/generator.rb | 4 | ||||
| -rw-r--r-- | lib/rdoc/generator/html/html.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/generator/ri.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/markup.rb | 6 | ||||
| -rw-r--r-- | lib/rdoc/markup/fragments.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/options.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/parsers/parse_c.rb | 8 | ||||
| -rw-r--r-- | lib/rdoc/parsers/parse_f95.rb | 8 | ||||
| -rw-r--r-- | lib/rdoc/parsers/parse_rb.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/rdoc.rb | 2 | ||||
| -rw-r--r-- | lib/rdoc/ri/descriptions.rb | 2 |
12 files changed, 22 insertions, 22 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README index cb00a5e355..f183c61f8d 100644 --- a/lib/rdoc/README +++ b/lib/rdoc/README @@ -17,7 +17,7 @@ document methods, classes, and so on. * If you want to include extensions written in C, see RDoc::C_Parser * For information on the various markups available in comment blocks, see RDoc::Markup. -* If you want to drive RDoc programatically, see RDoc::RDoc. +* If you want to drive RDoc programmatically, see RDoc::RDoc. * If you want to use the library to format text blocks into HTML, have a look at RDoc::Markup. * If you want to try writing your own HTML output template, see @@ -196,7 +196,7 @@ Comment blocks can contain other directives: Stop and start adding new documentation elements to the current container. For example, if a class has a number of constants that you don't want to document, put a +:stopdoc:+ before the first, and a +:startdoc:+ after the - last. If you don't specifiy a +:startdoc:+ by the end of the container, + last. If you don't specify a +:startdoc:+ by the end of the container, disables documentation for the entire class or module. = Other stuff diff --git a/lib/rdoc/generator.rb b/lib/rdoc/generator.rb index 322b25bf71..7c4ccf924a 100644 --- a/lib/rdoc/generator.rb +++ b/lib/rdoc/generator.rb @@ -7,12 +7,12 @@ require 'rdoc/template' module RDoc::Generator ## - # Name of sub-direcory that holds file descriptions + # Name of sub-directory that holds file descriptions FILE_DIR = "files" ## - # Name of sub-direcory that holds class descriptions + # Name of sub-directory that holds class descriptions CLASS_DIR = "classes" diff --git a/lib/rdoc/generator/html/html.rb b/lib/rdoc/generator/html/html.rb index 8343454d30..63c83ee5fd 100644 --- a/lib/rdoc/generator/html/html.rb +++ b/lib/rdoc/generator/html/html.rb @@ -7,7 +7,7 @@ require 'rdoc/generator/html/one_page_html' # This is a template for RDoc that uses XHTML 1.0 Transitional and dictates a # bit more of the appearance of the output to cascading stylesheets than the # default. It was designed for clean inline code display, and uses DHTMl to -# toggle the visbility of each method's source with each click on the '[source]' +# toggle the visibility of each method's source with each click on the '[source]' # link. # # == Authors diff --git a/lib/rdoc/generator/ri.rb b/lib/rdoc/generator/ri.rb index 2452d79132..ea0bbeffcc 100644 --- a/lib/rdoc/generator/ri.rb +++ b/lib/rdoc/generator/ri.rb @@ -45,7 +45,7 @@ class RDoc::Generator::RI def process_class(from_class) generate_class_info(from_class) - # now recure into this classes constituent classess + # now recurse into this classes constituent classes from_class.each_classmodule do |mod| process_class(mod) end diff --git a/lib/rdoc/markup.rb b/lib/rdoc/markup.rb index fdd1a11736..0e1b596255 100644 --- a/lib/rdoc/markup.rb +++ b/lib/rdoc/markup.rb @@ -17,7 +17,7 @@ require 'rdoc' # RDoc::Markup is intended to be the basis for a family of tools which share # the common requirement that simple, plain-text should be rendered in a # variety of different output formats and media. It is envisaged that -# RDoc::Markup could be the basis for formating RDoc style comment blocks, +# RDoc::Markup could be the basis for formatting RDoc style comment blocks, # Wiki entries, and online FAQs. # # = Basic Formatting @@ -129,7 +129,7 @@ require 'rdoc' # # You can extend the RDoc::Markup parser to recognise new markup # sequences, and to add special processing for text that matches a -# regular epxression. Here we make WikiWords significant to the parser, +# regular expression. Here we make WikiWords significant to the parser, # and also make the sequences {word} and \<no>text...</no> signify # strike-through text. When then subclass the HTML output class to deal # with these: @@ -197,7 +197,7 @@ class RDoc::Markup ## # Add to the sequences used to add formatting to an individual word (such - # as *bold*). Matching entries will generate attibutes that the output + # as *bold*). Matching entries will generate attributes that the output # formatters can recognize by their +name+. def add_word_pair(start, stop, name) diff --git a/lib/rdoc/markup/fragments.rb b/lib/rdoc/markup/fragments.rb index 1765861ad0..99780de169 100644 --- a/lib/rdoc/markup/fragments.rb +++ b/lib/rdoc/markup/fragments.rb @@ -12,7 +12,7 @@ class RDoc::Markup attr_accessor :type ###### - # This is a simple factory system that lets us associate fragement + # This is a simple factory system that lets us associate fragment # types (a string) with a subclass of fragment TYPE_MAP = {} diff --git a/lib/rdoc/options.rb b/lib/rdoc/options.rb index 8dc55a3f18..bc17fba8ad 100644 --- a/lib/rdoc/options.rb +++ b/lib/rdoc/options.rb @@ -571,7 +571,7 @@ Usage: #{opt.program_name} [options] [names...] end end - # Check that the right version of 'dot' is available. Unfortuately this + # Check that the right version of 'dot' is available. Unfortunately this # doesn't work correctly under Windows NT, so we'll bypass the test under # Windows. diff --git a/lib/rdoc/parsers/parse_c.rb b/lib/rdoc/parsers/parse_c.rb index 5771250cb9..745ee7aedd 100644 --- a/lib/rdoc/parsers/parse_c.rb +++ b/lib/rdoc/parsers/parse_c.rb @@ -117,10 +117,10 @@ module RDoc # method in the HTML output. This method must be in the same source file # as the rb_define_method. # - # C classes can be diagramed (see /tc/dl/ruby/ruby/error.c), and RDoc + # C classes can be diagrammed (see /tc/dl/ruby/ruby/error.c), and RDoc # integrates C and Ruby source into one tree # - # The comment blocks may include special direcives: + # The comment blocks may include special directives: # # [Document-class: <i>name</i>] # This comment block is documentation for the given class. Use this @@ -131,10 +131,10 @@ module RDoc # automatically find the method from it's declaration # # [call-seq: <i>text up to an empty line</i>] - # Because C source doesn't give descripive names to Ruby-level parameters, + # Because C source doesn't give descriptive names to Ruby-level parameters, # you need to document the calling sequence explicitly # - # In additon, RDoc assumes by default that the C method implementing a + # In addition, RDoc assumes by default that the C method implementing a # Ruby function is in the same source file as the rb_define_method call. # If this isn't the case, add the comment # diff --git a/lib/rdoc/parsers/parse_f95.rb b/lib/rdoc/parsers/parse_f95.rb index f3f6d76103..f1a1ae4d4b 100644 --- a/lib/rdoc/parsers/parse_f95.rb +++ b/lib/rdoc/parsers/parse_f95.rb @@ -201,7 +201,7 @@ module RDoc @progress = $stderr unless options.quiet end - # devine code constructs + # define code constructs def scan # remove private comment @@ -1065,7 +1065,7 @@ module RDoc # # If "all" argument is true, information of all arguments are returned. # If "modified_params" is true, list of arguments are decorated, - # for exameple, optional arguments are parenthetic as "[arg]". + # for example, optional arguments are parenthetic as "[arg]". # def find_arguments(args, text, all=nil, indent=nil, modified_params=nil) return unless args || all @@ -1143,8 +1143,8 @@ EOF # # Comments just after module or subprogram, or arguments are - # returnd. If "COMMENTS_ARE_UPPER" is true, comments just before - # modules or subprograms are returnd + # returned. If "COMMENTS_ARE_UPPER" is true, comments just before + # modules or subprograms are returned # def find_comments text return "" unless text diff --git a/lib/rdoc/parsers/parse_rb.rb b/lib/rdoc/parsers/parse_rb.rb index 64f49c97c2..5e223bf779 100644 --- a/lib/rdoc/parsers/parse_rb.rb +++ b/lib/rdoc/parsers/parse_rb.rb @@ -8,7 +8,7 @@ # This file contains stuff stolen outright from: # # rtags.rb - -# ruby-lex.rb - ruby lexcal analizer +# ruby-lex.rb - ruby lexcal analyzer # ruby-token.rb - ruby tokens # by Keiju ISHITSUKA (Nippon Rational Inc.) # diff --git a/lib/rdoc/rdoc.rb b/lib/rdoc/rdoc.rb index 38f6374764..81cae16bfd 100644 --- a/lib/rdoc/rdoc.rb +++ b/lib/rdoc/rdoc.rb @@ -134,7 +134,7 @@ module RDoc # subdirectories. # # The effect of this is that if you want a file with a non-standard - # extension parsed, you must name it explicity. + # extension parsed, you must name it explicitly. def normalized_file_list(options, relative_files, force_doc = false, exclude_pattern = nil) diff --git a/lib/rdoc/ri/descriptions.rb b/lib/rdoc/ri/descriptions.rb index adc3e7774b..0aef189025 100644 --- a/lib/rdoc/ri/descriptions.rb +++ b/lib/rdoc/ri/descriptions.rb @@ -83,7 +83,7 @@ class RDoc::RI::ModuleDescription < RDoc::RI::Description attr_accessor :constants attr_accessor :includes - # merge in another class desscription into this one + # merge in another class description into this one def merge_in(old) merge(@class_methods, old.class_methods) merge(@instance_methods, old.instance_methods) |