]> git.wincent.com - wikitext.git/blobdiff - doc/rdoc.rb
Add :pre_code option
[wikitext.git] / doc / rdoc.rb
index 51cc77a6c136f25d2f71807220794a28abb7444a..7db674293081143aa98dd10c6ea6c6dc376c2638 100644 (file)
@@ -119,6 +119,23 @@ module Wikitext
   #     !!!html
   #     http://apple.com/
   #
   #     !!!html
   #     http://apple.com/
   #
+  # == +pre_code+ (boolean)
+  #
+  # When true, "pre" blocks are formatted using "code" elements. For example:
+  #
+  #     !!!wikitext
+  #     <pre>foo</pre>
+  #
+  # Produces:
+  #
+  #     !!!html
+  #     <pre><code>foo</code></pre>
+  #
+  # When +false+ (the default), it produces:
+  #
+  #     !!!html
+  #     <pre>foo</pre>
+  #
   # == +space_to_underscore+ (boolean)
   #
   # Whether spaces in link targets should be encoded normally or transformed
   # == +space_to_underscore+ (boolean)
   #
   # Whether spaces in link targets should be encoded normally or transformed