diff options
| author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-01 07:12:49 +0000 |
|---|---|---|
| committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-01 07:12:49 +0000 |
| commit | 72550eee3d3596bcc2c8417cdc55211307799929 (patch) | |
| tree | c74f6e5b2b51f641cdc7895a37eb4c161b2c6d72 /lib/rdoc/markup/sample/sample.rb | |
| parent | a66baf78ffde5e07b44f8aa258933cf2d0afd6f6 (diff) | |
| download | ruby-72550eee3d3596bcc2c8417cdc55211307799929.tar.gz ruby-72550eee3d3596bcc2c8417cdc55211307799929.tar.xz ruby-72550eee3d3596bcc2c8417cdc55211307799929.zip | |
Add RDoc
git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@5073 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/markup/sample/sample.rb')
| -rw-r--r-- | lib/rdoc/markup/sample/sample.rb | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/lib/rdoc/markup/sample/sample.rb b/lib/rdoc/markup/sample/sample.rb new file mode 100644 index 000000000..a375b5456 --- /dev/null +++ b/lib/rdoc/markup/sample/sample.rb @@ -0,0 +1,42 @@ +# This program illustrates the basic use of the SimpleMarkup +# class. It extracts the first comment block from the +# simple_markup.rb file and converts it into HTML on +# standard output. Run it using +# +# % ruby sample.rb +# +# You should be in the sample/ directory when you do this, +# as it hardwires the path to the files it needs to require. +# This isn't necessary in the code you write once you've +# installed the package. +# +# For a better way of formatting code comment blocks (and more) +# see the rdoc package. +# + +$:.unshift "../../.." + +require 'rdoc/markup/simple_markup' +require 'rdoc/markup/simple_markup/to_html' + +# Extract the comment block from the source file + +input_string = "" + +File.foreach("../simple_markup.rb") do |line| + break unless line.gsub!(/^\# ?/, '') + input_string << line +end + +# Create a markup object +markup = SM::SimpleMarkup.new + +# Attach it to an HTML formatter +h = SM::ToHtml.new + +# And convert out comment block to html. Wrap it a body +# tag pair to let browsers view it + +puts "<html><body>" +puts markup.convert(input_string, h) +puts "</body></html>" |