mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
Add RDoc
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5073 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
parent
c1c55573bd
commit
87762adcb0
36 changed files with 12367 additions and 0 deletions
42
lib/rdoc/markup/sample/sample.rb
Normal file
42
lib/rdoc/markup/sample/sample.rb
Normal file
|
@ -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>"
|
Loading…
Add table
Add a link
Reference in a new issue