rice 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d302eb67c62576943948c960ff3fbd08b58488cd
-  data.tar.gz: 890eec0ab8be02d12ee4780d284c92c9c3f03a66
+SHA256:
+  metadata.gz: b94a556a35a6622bc3a5e9ca9f124020b0d22fffa319df33e3aa0bb35bae4d56
+  data.tar.gz: bcd79c325fb7cc04396720a8d987d55ba197079743971f012ca71ceeb16de2df
 SHA512:
-  metadata.gz: 365b2406ce20a999ebc98baa9d1da1847e278928ed498212b9f290e6a400e218b4dbd2f7c0be1da02fb68649e73a3a79d2da8914a39e9e9a5b9bb00b5c6f37ae
-  data.tar.gz: 5de69a6bf6ff0b4771f28c94fd399a141bddbd1a1b253ebede89468d4eb802708379c8c7ab85531d4842cff8c155dfc22856611b7e06c8e59d863bb64c338a47
+  metadata.gz: a6122026933d06b8866e486fcd954f6e55a148caab22fe95072cbf5ff6937936d2900e0374b6e276fb14c476c1413833cbd05e536757aea13f7ee431ac163a27
+  data.tar.gz: a7202f164e6cf63259bc3d2b8aa90a7306e53f88305f1c558a4ebd6d1d60b22e7eacf8466667b0fd3ce8123002e44a62a3896f9e4ecb69b3b412f09b23bf64af

data/COPYING

@@ -1,5 +1,5 @@
-Copyright (C) 2014 Paul Brannan <pbrannan@atdesk.com>,
-  Jason Roelofs <jasongroelofs@gmail.com>
+Copyright (C) 2020 Jason Roelofs <jasongroelofs@gmail.com>
+  Paul Brannan <curlypaul924@gmail.com>,
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

data/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Rice"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.1.0
+PROJECT_NUMBER         = 3.0.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -733,7 +733,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = rice
+INPUT                  = rice README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -753,7 +753,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.hpp README.doxygen
+FILE_PATTERNS          = *.hpp
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -869,7 +869,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1779,18 +1779,6 @@ GENERATE_XML           = NO
 
 XML_OUTPUT             = xml
 
-# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_SCHEMA             =
-
-# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_DTD                =
-
 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to
 # the XML output. Note that enabling this will significantly increase the size

data/Makefile.am

@@ -20,7 +20,7 @@ EXTRA_DIST = \
 	doxygen.am \
 	doc
 
-rice/README.doxygen: README
+rice/README.doxygen: README.md
 	@echo Generating documentation
-	@$(RUBY) -e 'File.open("README") { |i| File.open("rice/README.doxygen", "w") { |o| o.puts "/*! #{i.gets}"; i.each_line { |l| o.puts "    #{l}" if l !~ /^\\comment/ and l !~ /^vim:/ }; o.puts " */" } }'
+	@$(RUBY) -e 'File.open("README.md") { |i| File.open("rice/README.doxygen", "w") { |o| o.puts "/*! #{i.gets}"; i.each_line { |l| o.puts "    #{l}" if l !~ /^\\comment/ and l !~ /^vim:/ }; o.puts " */" } }'.md
 

data/Makefile.in

@@ -1,7 +1,7 @@
-# Makefile.in generated by automake 1.15 from Makefile.am.
+# Makefile.in generated by automake 1.16.3 from Makefile.am.
 # @configure_input@
 
-# Copyright (C) 1994-2014 Free Software Foundation, Inc.
+# Copyright (C) 1994-2020 Free Software Foundation, Inc.
 
 # This Makefile.in is free software; the Free Software Foundation
 # gives unlimited permission to copy and/or distribute it,
@@ -119,7 +119,7 @@ build_triplet = @build@
 host_triplet = @host@
 subdir = .
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
-am__aclocal_m4_deps = $(top_srcdir)/check_stdcxx_11.ac \
+am__aclocal_m4_deps = $(top_srcdir)/ax_cxx_compile_stdcxx.m4 \
 	$(top_srcdir)/ruby.ac $(top_srcdir)/doxygen.ac \
 	$(top_srcdir)/configure.ac
 am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
@@ -166,7 +166,7 @@ am__recursive_targets = \
   $(RECURSIVE_CLEAN_TARGETS) \
   $(am__extra_recursive_targets)
 AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \
-	cscope distdir dist dist-all distcheck
+	cscope distdir distdir-am dist dist-all distcheck
 am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
 # Read a list of newline-separated strings from the standard input,
 # and print each of them once, without duplicates.  Input order is
@@ -190,7 +190,7 @@ CSCOPE = cscope
 DIST_SUBDIRS = $(SUBDIRS)
 am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/doxygen.am \
 	$(top_srcdir)/rice/detail/ruby_version_code.hpp.in COPYING \
-	README TODO config.guess config.sub depcomp install-sh missing
+	config.guess config.sub depcomp install-sh missing
 DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
 distdir = $(PACKAGE)-$(VERSION)
 top_distdir = "$(distdir)"
@@ -229,6 +229,8 @@ am__relativize = \
 DIST_ARCHIVES = "$(distdir)".tar.gz
 GZIP_ENV = --best
 DIST_TARGETS = dist-gzip
+# Exists only to be overridden by the user if desired.
+AM_DISTCHECK_DVI_TARGET = dvi
 distuninstallcheck_listfiles = find . -type f -print
 am__distuninstallcheck_listfiles = $(distuninstallcheck_listfiles) \
   | sed 's|^\./|$(prefix)/|' | grep -v '$(infodir)/dir$$'
@@ -275,7 +277,7 @@ ECHO_C = @ECHO_C@
 ECHO_N = @ECHO_N@
 ECHO_T = @ECHO_T@
 EXEEXT = @EXEEXT@
-HAVE_CXX11 = @HAVE_CXX11@
+HAVE_CXX14 = @HAVE_CXX14@
 INSTALL = @INSTALL@
 INSTALL_DATA = @INSTALL_DATA@
 INSTALL_PROGRAM = @INSTALL_PROGRAM@
@@ -429,8 +431,8 @@ Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
 	    echo ' $(SHELL) ./config.status'; \
 	    $(SHELL) ./config.status;; \
 	  *) \
-	    echo ' cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__depfiles_maybe)'; \
-	    cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__depfiles_maybe);; \
+	    echo ' cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles)'; \
+	    cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__maybe_remake_depfiles);; \
 	esac;
 $(srcdir)/doxygen.am $(am__empty):
 
@@ -551,7 +553,10 @@ distclean-tags:
 	-rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags
 	-rm -f cscope.out cscope.in.out cscope.po.out cscope.files
 
-distdir: $(DISTFILES)
+distdir: $(BUILT_SOURCES)
+	$(MAKE) $(AM_MAKEFLAGS) distdir-am
+
+distdir-am: $(DISTFILES)
 	$(am__remove_distdir)
 	test -d "$(distdir)" || mkdir "$(distdir)"
 	@srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
@@ -616,7 +621,7 @@ distdir: $(DISTFILES)
 	  ! -type d ! -perm -444 -exec $(install_sh) -c -m a+r {} {} \; \
 	|| chmod -R a+r "$(distdir)"
 dist-gzip: distdir
-	tardir="$(distdir)" && $(am__tar) | GZIP=$(GZIP_ENV) gzip -c >"$(distdir)".tar.gz
+	tardir="$(distdir)" && $(am__tar) | eval GZIP= gzip $(GZIP_ENV) -c >"$(distdir)".tar.gz
 	$(am__post_remove_distdir)
 
 dist-bzip2: distdir
@@ -631,6 +636,10 @@ dist-xz: distdir
 	tardir="$(distdir)" && $(am__tar) | XZ_OPT=$${XZ_OPT--e} xz -c >"$(distdir)".tar.xz
 	$(am__post_remove_distdir)
 
+dist-zstd: distdir
+	tardir="$(distdir)" && $(am__tar) | zstd -c $${ZSTD_CLEVEL-$${ZSTD_OPT--19}} >"$(distdir)".tar.zst
+	$(am__post_remove_distdir)
+
 dist-tarZ: distdir
 	@echo WARNING: "Support for distribution archives compressed with" \
 		       "legacy program 'compress' is deprecated." >&2
@@ -642,7 +651,7 @@ dist-shar: distdir
 	@echo WARNING: "Support for shar distribution archives is" \
 	               "deprecated." >&2
 	@echo WARNING: "It will be removed altogether in Automake 2.0" >&2
-	shar "$(distdir)" | GZIP=$(GZIP_ENV) gzip -c >"$(distdir)".shar.gz
+	shar "$(distdir)" | eval GZIP= gzip $(GZIP_ENV) -c >"$(distdir)".shar.gz
 	$(am__post_remove_distdir)
 
 dist-zip: distdir
@@ -660,7 +669,7 @@ dist dist-all:
 distcheck: dist
 	case '$(DIST_ARCHIVES)' in \
 	*.tar.gz*) \
-	  GZIP=$(GZIP_ENV) gzip -dc "$(distdir)".tar.gz | $(am__untar) ;;\
+	  eval GZIP= gzip $(GZIP_ENV) -dc "$(distdir)".tar.gz | $(am__untar) ;;\
 	*.tar.bz2*) \
 	  bzip2 -dc "$(distdir)".tar.bz2 | $(am__untar) ;;\
 	*.tar.lz*) \
@@ -670,9 +679,11 @@ distcheck: dist
 	*.tar.Z*) \
 	  uncompress -c "$(distdir)".tar.Z | $(am__untar) ;;\
 	*.shar.gz*) \
-	  GZIP=$(GZIP_ENV) gzip -dc "$(distdir)".shar.gz | unshar ;;\
+	  eval GZIP= gzip $(GZIP_ENV) -dc "$(distdir)".shar.gz | unshar ;;\
 	*.zip*) \
 	  unzip "$(distdir)".zip ;;\
+	*.tar.zst*) \
+	  zstd -dc "$(distdir)".tar.zst | $(am__untar) ;;\
 	esac
 	chmod -R a-w "$(distdir)"
 	chmod u+w "$(distdir)"
@@ -688,7 +699,7 @@ distcheck: dist
 	    $(DISTCHECK_CONFIGURE_FLAGS) \
 	    --srcdir=../.. --prefix="$$dc_install_base" \
 	  && $(MAKE) $(AM_MAKEFLAGS) \
-	  && $(MAKE) $(AM_MAKEFLAGS) dvi \
+	  && $(MAKE) $(AM_MAKEFLAGS) $(AM_DISTCHECK_DVI_TARGET) \
 	  && $(MAKE) $(AM_MAKEFLAGS) check \
 	  && $(MAKE) $(AM_MAKEFLAGS) install \
 	  && $(MAKE) $(AM_MAKEFLAGS) installcheck \
@@ -849,7 +860,7 @@ uninstall-am:
 	am--refresh check check-am clean clean-cscope clean-generic \
 	cscope cscopelist-am ctags ctags-am dist dist-all dist-bzip2 \
 	dist-gzip dist-lzip dist-shar dist-tarZ dist-xz dist-zip \
-	distcheck distclean distclean-generic distclean-tags \
+	dist-zstd distcheck distclean distclean-generic distclean-tags \
 	distcleancheck distdir distuninstallcheck dvi dvi-am html \
 	html-am info info-am install install-am install-data \
 	install-data-am install-dvi install-dvi-am install-exec \
@@ -911,9 +922,9 @@ uninstall-am:
 
 doc: doxygen-doc
 
-rice/README.doxygen: README
+rice/README.doxygen: README.md
 	@echo Generating documentation
-	@$(RUBY) -e 'File.open("README") { |i| File.open("rice/README.doxygen", "w") { |o| o.puts "/*! #{i.gets}"; i.each_line { |l| o.puts "    #{l}" if l !~ /^\\comment/ and l !~ /^vim:/ }; o.puts " */" } }'
+	@$(RUBY) -e 'File.open("README.md") { |i| File.open("rice/README.doxygen", "w") { |o| o.puts "/*! #{i.gets}"; i.each_line { |l| o.puts "    #{l}" if l !~ /^\\comment/ and l !~ /^vim:/ }; o.puts " */" } }'.md
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.

data/{README → README.md}

@@ -1,85 +1,87 @@
-\mainpage Rice - Ruby Interface for C++ Extensions
+# Rice - Ruby Interface for C++ Extensions {#mainpage}
 
+# Introduction {#intro}
 
-\section intro Introduction
-
-Rice is a C++ interface to Ruby's C API.  It provides a type-safe and
+Rice is a C++ interface to Ruby's C API. It provides a type-safe and
 exception-safe interface in order to make embedding Ruby and writing
-Ruby extensions with C++ easier.  It is similar to Boost.Python in many
-ways, but also attempts to provide an object-oriented interface to all
+Ruby extensions with C++ easier. It is similar to Boost.Python or pybind11
+in many ways, but also attempts to provide an object-oriented interface to all
 of the Ruby C API.
 
 What Rice gives you:
-\li A simple C++-based syntax for wrapping and defining classes
-\li Automatic conversion of exceptions between C++ and Ruby
-\li Smart pointers for handling garbage collection
-\li Wrappers for most builtin types to simplify calling code
+- A simple C++-based syntax for wrapping and defining classes
+- Automatic conversion of exceptions between C++ and Ruby
+- Smart pointers for handling garbage collection
+- Wrappers for most builtin types to simplify calling code
 
-\section project Project Details
+# Project Details {#project}
 
-The source is hosted on github: http://github.com/jasonroelofs/rice
+The source is hosted on GitHub: http://github.com/jasonroelofs/rice
 
 Bug tracking: http://github.com/jasonroelofs/rice/issues
 
-\section installation Installation
+API documentation: http://jasonroelofs.github.io/rice
+
+# Installation {#installation}
 
-\code
+~~~
   gem install rice
-\endcode
+~~~
 
 Building it locally from a clone of the repository is as follows:
 
-\code
+~~~
   ./bootstrap
   ruby extconf.rb
   make
-\endcode
+~~~
+
+Rice is known to work on *nix, OSX, and Windows.
 
-Rice is known to work on *nix and OSX. Windows is not currently
-supported.
+Rice requires a C++ compiler with support for C++14 or later.
 
-\section tutorial Tutorial
+# Tutorial {#tutorial}
 
-\subsection geting_started Getting started
+## Getting started {#getting_started}
 
 Writing an extension with Rice is very similar to writing an extension
 with the C API.
 
 The first step is to create an extconf.rb file:
 
-\code
+~~~{.cpp}
   require 'mkmf-rice'
   create_makefile('test')
-\endcode
+~~~
 
-Note that we use mkmf-rice instead of mkmf.  This will ensure that the
+Note that we use `mkmf-rice` instead of `mkmf`. This will ensure that the
 extension will be linked with standard C++ library along with the Rice
 library, and allow access to the Rice header files.
 
 Next we create our extension and save it to test.cpp:
 
-\code
+~~~{.cpp}
   extern "C"
   void Init_test()
   {
   }
-\endcode
+~~~
 
-Note the extern "C" line above.  This tells the compiler that the
-function Init_test should have C linkage and calling convention.  This
+Note the extern "C" line above. This tells the compiler that the
+function `Init_test` should have C linkage and calling convention. This
 turns off name mangling so that the Ruby interpreter will be able to
 find the function (remember that Ruby is written in C, not C++).
 
 So far we haven't put anything into the extension, so it isn't
-particularly useful.  The next step is to define a class so we can add
+particularly useful. The next step is to define a class so we can add
 methods to it.
 
 
-\subsection classes Defining clases
+## Defining clases {#classes}
 
-Defining a class in Rice is easy:
+Defining a class in Rice is a single call:
 
-\code
+~~~{.cpp}
   #include "rice/Class.hpp"
 
   using namespace Rice;
@@ -89,12 +91,12 @@ Defining a class in Rice is easy:
   {
     Class rb_cTest = define_class("Test");
   }
-\endcode
+~~~
 
-This will create a class called Test that inherits from Object.  If we
-wanted to inherit from a different class, we could easily do so:
+This will create a class called `Test` that inherits from `Object`. If we
+wanted to inherit from a different class, we do so with the second parameter:
 
-\code
+~~~{.cpp}
   #include "rice/Class.hpp"
 
   using namespace Rice;
@@ -104,34 +106,34 @@ wanted to inherit from a different class, we could easily do so:
   {
     Class rb_cMySocket = define_class("MySocket", rb_cIO);
   }
-\endcode
+~~~
 
-Note the prefix rb_c on the name of the class.  This is a convention
-that the Ruby interpreter and many extensions tend to use.  It signifies
-that this is a class and not some other type of object.  Some other
+Note the prefix rb_c on the name of the class. This is a convention
+that the Ruby interpreter and many extensions tend to use. It signifies
+that this is a class and not some other type of object. Some other
 naming conventions that are commonly used:
 
-\li rb_c variable name prefix for a Class
-\li rb_m variable name prefix for a Module
-\li rb_e variable name prefix for an Exception type
-\li rb_  function prefix for a function in the Ruby C API
-\li rb_f_ function prefix to differentiate between an API function that
+- rb_c variable name prefix for a Class
+- rb_m variable name prefix for a Module
+- rb_e variable name prefix for an Exception type
+- rb_  function prefix for a function in the Ruby C API
+- rb_f_ function prefix to differentiate between an API function that
 takes Ruby objects as arguments and one that takes C argument types
-\li rb_*_s_ indicates the function is a singleton function
-\li *_m suffix to indicate the function takes variable number of
+- rb_*_s_ indicates the function is a singleton function
+- *_m suffix to indicate the function takes variable number of
 arguments
 
 
-Also note that we don't include "ruby.h" directly.  Rice has a wrapper
+Also note that we don't include "ruby.h" directly. Rice has a wrapper
 for ruby.h that handles some compatibility issues across platforms and
-Ruby versions.  Always include Rice headers before including anything
+Ruby versions. Always include Rice headers before including anything
 that might include "ruby.h".
 
-\subsection methods Defining methods
+## Defining methods {#methods}
 
 Now let's add a method to our class:
 
-\code
+~~~{.cpp}
   #include "rice/Class.hpp"
   #include "rice/String.hpp"
 
@@ -150,15 +152,15 @@ Now let's add a method to our class:
       define_class("Test")
       .define_method("hello", &test_hello);
   }
-\endcode
+~~~
 
-Here we add a method Test#hello that simply returns the string
-"Hello, World".  The method takes self as an implicit parameter, but
+Here we add a method `%Test#hello` that returns the string
+"Hello, World". The method takes self as an implicit parameter, but
 isn't used, so we comment it out to prevent a compiler warning.
 
-We could also add an #initialize method to our class:
+We could also add an `#initialize` method to our class:
 
-\code
+~~~{.cpp}
   #include "rice/Class.hpp"
   #include "rice/String.hpp"
 
@@ -180,21 +182,21 @@ We could also add an #initialize method to our class:
   {
     Class rb_cTest =
       define_class("Test")
-      .define_method("initialize", &test_initialize);
+      .define_method("initialize", &test_initialize)
       .define_method("hello", &test_hello);
   }
-\endcode
+~~~
 
-The initialize method sets an instance variable @foo to the value 42.
-The number is automatically converted to a Fixnum before doing the
+The `initialize` method sets an instance variable `@foo` to the value 42.
+The number is automatically converted to a `Fixnum` before doing the
 assignment.
 
-Note that we're chaining calls on the Class object.  Most member
-functions in Module and Class return a reference to self, so we can
+Note that we're chaining calls on the `Class` object. Most member
+functions in `Module` and `Class` return a reference to `self`, so we can
 chain as many calls as we want to define as many methods as we want.
 
 
-\subsection data_types Wrapping C++ Types
+## Wrapping C++ Types {#data_types}
 
 It's useful to be able to define Ruby classes in a C++ style rather than
 using the Ruby API directly, but the real power Rice is in wrapping
@@ -202,19 +204,19 @@ already-defined C++ types.
 
 Let's assume we have the following C++ class that we want to wrap:
 
-\code
+~~~{.cpp}
   class Test
   {
   public:
     Test();
     std::string hello();
   };
-\endcode
+~~~
 
 This is a C++ version of the Ruby class we just created in the previous
-section.  To wrap it:
+section. To wrap it:
 
-\code
+~~~{.cpp}
   #include "rice/Data_Type.hpp"
   #include "rice/Constructor.hpp"
 
@@ -228,57 +230,57 @@ section.  To wrap it:
       .define_constructor(Constructor<Test>())
       .define_method("hello", &Test::hello);
   }
-\endcode
+~~~
 
-This example is similar to the one before, but we use Data_Type<>
-instead of Class and the template version of define_class() instead of
-the non-template version.  This creates a binding in the Rice library
-between the Ruby class Test and the C++ class Test such that Rice passes
-member function pointers to define_method().
+This example is similar to the one before, but we use `Data_Type<>`
+instead of `Class` and the template version of define_class() instead of
+the non-template version. This creates a binding in the Rice library
+between the Ruby class `Test` and the C++ class Test such that Rice passes
+member function pointers to `define_method()`.
 
 It is possible to write the conversion functions ourself (as we'll see
 below), but Rice does all the dirty work for us.
 
 
-\subsection conversions Type conversions
+## Type conversions {#conversions}
 
 Let's look again at our example class:
 
-\code
+~~~{.cpp}
   class Test
   {
   public:
     Test();
     std::string hello();
   };
-\endcode
+~~~
 
 When we wrote our class, we never wrote a single line of code to convert
-the std::string returned by hello() into a Ruby type.  Neverthless, the
+the `std::string` returned by `hello()` into a Ruby type. Neverthless, the
 conversion works, and when we write:
 
-\code
+~~~{.cpp}
   test = Test.new
   puts test.hello
-\endcode
+~~~
 
 We get the expected result.
 
 Rice has two template conversion functions to convert between C++ and
 Ruby types:
 
-\code
+~~~{.cpp}
   template<typename T>
   T from_ruby(Object x);
 
   template<typename T>
   Object to_ruby(T const & x);
-\endcode
+~~~
 
-Rice has included by default specializations for many of the builtin
-types.  To define your own conversion, you can write a specialization:
+Rice includes default specializations for many of the builtin
+types. To define your own conversion, write a template specialization:
 
-\code
+~~~{.cpp}
   template<>
   Foo from_ruby<Foo>(Object x)
   {
@@ -290,17 +292,17 @@ types.  To define your own conversion, you can write a specialization:
   {
     // ...
   }
-\endcode
+~~~
 
 The implementation of these functions would, of course, depend on the
-implementation of Foo.
+implementation of `Foo`.
 
 
-\subsection data_conversions Conversions for wrapped C++ types
+## Conversions for wrapped C++ types {#data_conversions}
 
-Take another look at the wrapper we wrote for the Test class:
+Take another look at the wrapper we wrote for the `Test` class:
 
-\code
+~~~{.cpp}
   extern "C"
   void Init_test()
   {
@@ -309,62 +311,62 @@ Take another look at the wrapper we wrote for the Test class:
       .define_constructor(Constructor<Test>())
       .define_method("hello", &Test::hello);
   }
-\endcode
+~~~
 
-When we called define_class<Test>, it created a Class for us and
+When we called `define_class<Test>`, it created a Class for us and
 automatically registered the new Class with the type system, so that the
 calls:
 
-\code
+~~~{.cpp}
   Data_Object<Foo> obj(new Foo);
   Foo * f = from_ruby<Foo *>(obj);
   Foo const * f = from_ruby<Foo const *>(obj);
-\endcode
+~~~
 
-work as expected.
+works as expected.
 
-The Data_Object class is a wrapper for the Data_Wrap_Struct and the
-Data_Get_Struct macros in C extensions.  It can be used to wrap or
-unwrap any class that has been assigned to a Data_Type.  It inherits
-from Object, so any member functions we can call on an Object we can
-also call on a Data_Object:
+The `Data_Object` class is a wrapper for the `Data_Wrap_Struct` and the
+`Data_Get_Struct` macros in C extensions. It can be used to wrap or
+unwrap any class that has been assigned to a `Data_Type`. It inherits
+from `Object`, so any member functions we can call on an `Object` we can
+also call on a `Data_Object`:
 
-\code
+~~~{.cpp}
   Object object_id = obj.call("object_id");
   std::cout << object_id << std::endl;
-\endcode
+~~~
 
-The Data_Object class can be used to wrap a newly-created object:
+The `Data_Object` class can be used to wrap a newly-created object:
 
-\code
+~~~{.cpp}
   Data_Object<Foo> foo(new Foo);
-\endcode
+~~~
 
 or to unwrap an already-created object:
 
-\code
+~~~{.cpp}
   VALUE obj = ...;
   Data_Object<Foo> foo(obj);
-\endcode
+~~~
 
-A Data_Object functions like a smart pointer:
+A `Data_Object` functions like a smart pointer:
 
-\code
+~~~{.cpp}
   Data_Object<Foo> foo(obj);
   foo->foo();
   std::cout << *foo << std::endl;
-\endcode
+~~~
 
-Like a VALUE or an Object, data stored in a Data_Object will be marked
-by the garbage collector as long as the Data_Object is on the stack.
+Like a `VALUE` or an `Object`, data stored in a `Data_Object` will be marked
+by the garbage collector as long as the `Data_Object` is on the stack.
 
 
-\subsection exception Exceptions
+## Exceptions {#exception}
 
 Suppose we added a member function to our example class that throws an
 exception:
 
-\code
+~~~{.cpp}
   class MyException
     : public std::exception
   {
@@ -377,11 +379,11 @@ exception:
     std::string hello();
     void error();
   };
-\endcode
+~~~
 
 If we were to wrap this function:
 
-\code
+~~~{.cpp}
   extern "C"
   void Init_test()
   {
@@ -391,22 +393,22 @@ If we were to wrap this function:
       .define_method("hello", &Test::hello)
       .define_method("error", &Test::error);
   }
-\endcode
+~~~
 
 and call it from inside Ruby:
 
-\code
+~~~{.cpp}
   test = Test.new
   test.error()
-\endcode
+~~~
 
-we would get an exception.  Rice will automatically convert any
-C++ exception it catches into a Ruby exception.  But what if we wanted
+we would get an exception. Rice will automatically convert any
+C++ exception it catches into a Ruby exception. But what if we wanted
 to use a custom error message when we convert the exception, or what if
-we wanted to convert to a different type of exception?  We can write
-this:
+we wanted to convert to a different type of exception? We can write
+an exception handler like so:
 
-\code
+~~~{.cpp}
   extern "C"
   void Init_test()
   {
@@ -417,70 +419,70 @@ this:
       .define_method("hello", &Test::hello)
       .define_method("error", &Test::error);
   }
-\endcode
+~~~
 
-The handle_my_exception function need only rethrow the exception as a
-Rice::Exception:
+The `handle_my_exception` function need only rethrow the exception as a
+`Rice::Exception`:
 
-\code
+~~~{.cpp}
   void handle_my_exception(MyException const & ex)
   {
     throw Exception(rb_eRuntimeError, "Goodnight, moon");
   }
-\endcode
+~~~
 
-And what if we want to call Ruby code from C++?  These exceptions are
+And what if we want to call Ruby code from C++? These exceptions are
 also converted:
 
-\code
+~~~{.cpp}
   Object o;
   o.call("some_function_that_raises", 42);
 
   protect(rb_raise, rb_eRuntimeError, "some exception msg");
-\endcode
+~~~
 
 Internally whenever Rice catches a C++ or a Ruby exception, it converts
-it to an Exception object.  This object will later be re-raised as a
+it to an `Exception` object. This object will later be re-raised as a
 Ruby exception when control is returned to the Ruby VM.
 
-Rice uses a similar class called Jump_Tag to handle symbols thrown by
-Ruby's throw/catch or other non-local jumps from inside the Ruby VM.
+Rice uses a similar class called `Jump_Tag` to handle symbols thrown by
+Ruby's `throw`/`catch` or other non-local jumps from inside the Ruby VM.
 
 
-\subsection builtin Builtin Types
+## Builtin Types {#builtin}
 
 You've seen this example:
 
-\code
+~~~{.cpp}
   Object object_id = obj.call("object_id");
   std::cout << object_id << std::endl;
-\endcode
+~~~
 
 Rice mimics the Ruby class hierarchy as closely as it can.
 In fact, the above code also works for Classes:
 
-\code
+~~~{.cpp}
   Class rb_cTest = define_class<Test>("Test");
   Object object_id = rb_cTest.call("object_id");
   std::cout << object_id << std::endl;
-\endcode
+~~~
 
 Rice provides builtin wrappers for many builtin Ruby types, including:
 
-\li Object
-\li Module
-\li Class
-\li String
-\li Array
-\li Hash
-\li Struct
-\li Symbol
-\li Exception
-
-The Array and Hash types can even be iterated over the same way one
+- Object
+- Module
+- Class
+- String
+- Array
+- Hash
+- Struct
+- Symbol
+- Exception
+
+The `Array` and `Hash` types can even be iterated over the same way one
 would iterate over an STL container:
 
-\code
+~~~{.cpp}
   Array a;
   a.push(to_ruby(42));
   a.push(to_ruby(43));
@@ -491,21 +493,21 @@ would iterate over an STL container:
   {
     std::cout << *it << std::endl;
   }
-\endcode
+~~~
 
-STL algorithms should also work as expected on Array and Hash containers.
+STL algorithms should also work as expected on `Array` and `Hash` containers.
 
 
-\subsection inheritance Inheritance
+## Inheritance {#inheritance}
 
-Inheritance is a tricky problem to solve in extensions.  This is because
+Inheritance is a tricky problem to solve in extensions. This is because
 wrapper functions for base classes typically don't know how to accept
-pointers to derived classes.  It is possible to write this logic, but
+pointers to derived classes. It is possible to write this logic, but
 the code is nontrivial.
 
-Forunately Rice handles this gracefully:
+Rice also provides a solution to this problem:
 
-\code
+~~~{.cpp}
   class Base
   {
   public:
@@ -526,33 +528,33 @@ Forunately Rice handles this gracefully:
     Data_Type<Derived> rb_cDerived =
       define_class<Derived, Base>("Derived");
   }
-\endcode
+~~~
 
-The second template parameter to define_class indicates that Derived
-inherits from Base.
+The second template parameter to define_class indicates that `Derived`
+inherits from `Base`.
 
 Rice does not support multiple inheritance.
 
 
-\subsection overloading Overloaded functions
+## Overloaded functions {#overloading}
 
 If you try to create a member function pointer to an overloaded
-function, you will get an error.  So how do we wrap classes that have
+function, you will get an error. So how do we wrap classes that have
 overloaded functions?
 
 Consider a class that uses this idiom for accessors:
 
-\code
+~~~{.cpp}
   class Container
   {
     size_t capacity(); // Get the capacity
     void capacity(size_t cap); // Set the capacity
   };
-\endcode
+~~~
 
-We can wrap this class by using typedefs:
+We can wrap this class by using `typedef`s:
 
-\code
+~~~{.cpp}
   extern "C"
   void Init_Container()
   {
@@ -564,45 +566,44 @@ We can wrap this class by using typedefs:
       .define_method("capacity", get_capacity(&Container::capacity))
       .define_method("capacity=", set_capacity(&Container::capacity))
   }
-\endcode
+~~~
 
 
-\subsection user_defined_conversions User-defined type conversions
+## User-defined type conversions {#user_defined_conversions}
 
-Rice provides default conversions for many built-in types.  Sometimes,
-however, the default conversion is not what is expected.  For
+Rice provides default conversions for many built-in types. Sometimes,
+however, the default conversion is not what is expected. For
 example, consider a function:
 
-\code
+~~~{.cpp}
   void foo(char * x);
-\endcode
+~~~
 
-Is x a pointer to a single character or a pointer to the first character
+Is `x` a pointer to a single character or a pointer to the first character
 of a null-terminated string or a pointer to the first character of an
 array of char?
 
 Because the second case is the most common use case (a pointer to the
 first character of a C string), Rice provides a default conversion that
-treats a char * as a C string.  But suppose the above function takes a
-pointer to a char instead?
+treats a `char *` as a C string. But suppose the above function actually
+expects to receive a pointer to a single char instead?
 
 If we write this:
 
-\comment : -- this comment is to satisfy vim syntax highlighting --
-
-\code
+~~~{.cpp}
   extern "C"
   void Init_test()
   {
     define_global_function("foo", &foo);
   }
-\endcode
+~~~
 
 It will likely have the wrong behavior.
 
-To avoid this problem, it is necessary to write a wrapper function:
+To avoid this problem, it is necessary to write a wrapper function where
+the extension can be more explicit about how to handle the parameters:
 
-\code
+~~~{.cpp}
   Object wrap_foo(Object o)
   {
     char c = from_ruby<char>(o);
@@ -615,30 +616,30 @@ To avoid this problem, it is necessary to write a wrapper function:
   {
     define_global_function("foo", &wrap_foo);
   }
-\endcode
+~~~
 
-Note that the out parameter is returned from wrap_foo, as Ruby does not
+Note that the out parameter is returned from `wrap_foo`, as Ruby does not
 have pass-by-variable-reference (it uses pass-by-object-reference).
 
 
-\subsection default_arguments Default Arguments
+## Default Arguments {#default_arguments}
 
-Going back to our initial C++ class example, lets say that hello() now
+Going back to our initial C++ class example, lets say that `hello()` now
 takes more arguments, one of which has a default value:
 
-\code
+~~~{.cpp}
   class Test
   {
   public:
     Test();
     std::string hello(std::string first, std::string second = "world");
   };
-\endcode
+~~~
 
 As default parameter information is not available through templates,
-it is necessary to define this in Rice explicitly using Rice::Arg:
+it is necessary to define this in Rice explicitly using `Rice::Arg`:
 
-\code
+~~~{.cpp}
   #include "rice/Data_Type.hpp"
   #include "rice/Constructor.hpp"
 
@@ -655,70 +656,70 @@ it is necessary to define this in Rice explicitly using Rice::Arg:
          (Arg("hello"), Arg("second") = "world")
       );
   }
-\endcode
+~~~
 
-The syntax here is simply Arg(nameOfParameter)[ = defaultValue].  The name of the
-parameter is not important here (a readability tool), but the value set via operator=
+The syntax here is `Arg(nameOfParameter)[ = defaultValue]`. The name of the
+parameter is not important here (it is for readability), but the value set via `operator=`
 must match the type of the parameter. As such it may be necessary to
 explicitly cast the default value.
 
-\code
+~~~{.cpp}
   .define_method("hello",
      &Test::hello,
      (Arg("hello"), Arg("second") = (std::string)"world")
   );
-\endcode
+~~~
 
-These Rice::Arg objects must be in the correct order and must be
+These `Rice::Arg` objects must be in the correct order and must be
 surrounded with parentheses if more than one exists.
 
 Now, Ruby will now know about the default arguments, and this wrapper
 can be used as expected:
 
-\code
+~~~{.cpp}
   t = Test.new
   t.hello("hello")
   t.hello("goodnight", "moon")
-\endcode
+~~~
 
 This also works with Constructors:
 
-\code
+~~~{.cpp}
   .define_constructor(Constructor<SomeClass, int, int>(),
       ( Arg("arg1") = 1, Arg("otherArg") = 12 );
-\endcode
+~~~
 
-\subsection director Director
+## Director {#director}
 
-As polymorphism is the most important tennant of Object Oriented Programming,
-it is important that Rice supports polymorphic calls travelling between C++
-and Ruby seemlessly. Super calls from Ruby subclasses back into C++ already work,
-but enabling the other direction requires some extra effort. Rice
-suppplies the the Rice::Director class and
-Rice::Data_Type::define_director to expose this functionality.
+Polymorphism creates yet another wrinkle in building exceptions around C++ code,
+because now we have to deal with cross-language polymorphism, where C++ can call
+into a Ruby subclass, and a Ruby subclass can `super` back into C++ land. `super`
+calls already work through define_class, but making code travel from C++ into Ruby
+via polymorphism is tricker. Rice provides the `Rice::Director` class and the
+`define_director` method to enable this code path.
 
-Like SWIG_Director, Rice::Director is a class that is used to build a proxy class
-to properly send execution up or down the object heiarchy for that class. Take
+Like `SWIG_Director`, `Rice::Director` is a class that is used to build a proxy class
+to properly send execution up or down the object hierarchy for that class. Take
 the following class:
 
-\code
+~~~{.cpp}
   class VirtualBase {
     public:
       VirtualBase();
       virtual int doWork();
       virtual int processWorker() = 0;
   };
-\endcode
+~~~
 
-Due to the abstract nature of this class, it will not work at all with Rice
-in its current form. Any attempt to do so will cause a compilation error due to
-this class not being constructable. Even without the pure virtual function, any
-call to VirtualBase::doWork will stop at the C++ level and will not pass down into
-any Ruby subclasses.
+Due to the abstract nature of this class, we cannot directly wrap it in Rice, as
+any C++ compiler will complain about trying to instantiate a virtual class.
+Even without the pure virtual function, any call to `VirtualBase::doWork` will stop
+at the C++ level and execution will not pass down into any Ruby subclasses.
 
-To properly wrap both of these methods, use a Rice::Director subclass as a proxy:
+To properly wrap both of these methods, use a `Rice::Director` subclass as a proxy
+and use this new proxy class as the type to wrap with `define_class`:
 
-\code
+~~~{.cpp}
   #include "rice/Director.hpp"
 
   class VirtualBaseProxy : public VirtualBase, public Rice::Director {
@@ -741,27 +742,27 @@ To properly wrap both of these methods, use a Rice::Director subclass as a proxy
         raisePureVirtual();
       }
   };
-\endcode
+~~~
 
 There is a lot going on here, so we'll go through each part.
 
-\code
+~~~{.cpp}
   class VirtualBaseProxy : public Virtualbase, public Rice::Director {
-\endcode
+~~~
 
-First, the class needs to subclass both the virtual class in question and Rice::Director.
+First, the class needs to subclass both the virtual class in question and `Rice::Director`.
 
-\code
+~~~{.cpp}
     public:
       VirtualBaseProxy(Object self) : Rice::Director(self) { }
-\endcode
+~~~
 
-For Rice::Director to work its magic, every instance of this class needs to
-have a handle to the Ruby instance. The constructor
-must take a Rice::Object as the first argument and pass it up into
-Rice::Director. The code here is the minimum required for a Rice::Director proxy.
+For `Rice::Director` to work its magic, every instance of this class needs to
+have a handle to its Ruby instance. The constructor
+must take a `Rice::Object` as the first argument and pass it up into
+`Rice::Director`. The code here is the minimum required for a `Rice::Director` proxy.
 
-\code
+~~~{.cpp}
       virtual int doWork() {
         return from_ruby<int>( getSelf().call("do_work") );
       }
@@ -769,33 +770,29 @@ Rice::Director. The code here is the minimum required for a Rice::Director proxy
       int default_doWork() {
         return VirtualBase::doWork();
       }
-\endcode
-
-Here the directory proxy overrides the methods for Ruby exposure and
-implements the required actions to pass flow around the heirarchy
-appropriately. The pattern shown here is that the actual override will
-call down into Ruby, handling any type conversions, while a
-default_methodName method handles calling up into C++ and will be the
-method wrapped into Rice.
+~~~
 
-The default_doWork method will be used as Rice's hookup of calling back up the 
-heirarchy (wrapping is below). This method needs to do one of two things: call
-up the class heirarchy, as seen here, or call raisePureVirtual() as seen in the
-processWorker example:
+Here the proxy class implements the virtual methods and provides implementations
+that delegate execution in the correct direction. The actual method calls into Ruby,
+providing all necessary type conversions to and from C++ types. The other method
+is how Ruby calls back into C++ and is the method that must be exposed with
+`define_method`. The `default_` prefix is a naming convention to help keep straight
+which methods perform which function. If Ruby should never call into C++, then the
+`default_` implementation should call `raisePureVirtual()`:
 
-\code
+~~~{.cpp}
       int default_processWorker() {
         raisePureVirtual();
       }
-\endcode
+~~~
 
-The method raisePureVirtual() exists to allow wrapping a pure virtual method into Ruby
-(and ensuring compliation is possible) but making sure any users of this extension are 
+The method `raisePureVirtual()` exists to allow wrapping a pure virtual method into Ruby
+(and ensuring compliation is possible) but making sure any users of this extension are
 informed quickly that there's nothing callable in the C++ side of the library.
 
 Once the proxy class is built, it's time to wrap it into Ruby:
 
-\code
+~~~{.cpp}
 extern "C"
 void Init_virtual() {
   define_class<VirtualBase>("VirtualBase")
@@ -804,28 +801,28 @@ void Init_virtual() {
     .define_method("do_work", &VirtualBaseProxy::default_doWork)
     .define_method("process_worker", &VirtualBaseProxy::default_processWorker);
 }
-\endcode
+~~~
 
 The wrapping is the same as is described earlier in this document. Expose the class
-VirtualBase, and register VirtualBaseProxy as a director proxy of VirtualBase with
-Rice::Data_Type::define_director, then define methods pointing to the proxy object as necessary.
+`VirtualBase`, and register `VirtualBaseProxy` as a director proxy of `VirtualBase` with
+`Rice::Data_Type::define_director`, then `define_method`s pointing to the proxy methods as necessary.
 
-You must use the Rice::Director proxy class in the Constructor line, this allows proper
+You must use the `Rice::Director` proxy class in the Constructor line, this allows proper
 object construction / destruction of the types in question.
 
-\subsection implicit_cast Implicit Casting
+## Implicit Casting {#implicit_cast}
 
 There are times when a library exposes classes that, while unrelated, are
 built to be interchangeable across the library. One example of this is found in
 the Open Source 3d rendering engine <a
 href="http://www.ogre3d.org/">OGRE</a>: Ogre::Degree and Ogre::Radian.
-When a given method takes a Radian, you're free to pass in a Degree, and vice versa. 
+When a given method takes a Radian, you're free to pass in a Degree, and vice versa.
 
 Rice cannot automatically figure out if this kind of functionality is
 possible in a given library but it does provide an API for defining
-these relationships: Rice::define_implicit_cast<From, To>().
+these relationships: `Rice::define_implicit_cast<From, To>()`.
 
-\code
+~~~{.cpp}
 class Degree { ... };
 class Radian { ... };
 
@@ -839,79 +836,79 @@ void Init_implicit() {
   define_implicit_cast<Degree, Radian>();
   define_implicit_cast<Radian, Degree>();
 }
-\endcode
+~~~
 
-Using Rice::define_implicit_cast has the following requirements:
+Using `Rice::define_implicit_cast` has the following requirements:
 
-\li The two types must be bound in Rice before defining the cast.
-\li The classes must have constructors that take the other type.
-\li This feature cannot be used with fundamental types.
+- The two types must be bound in Rice before defining the cast.
+- The classes must have constructors that take the other type.
+- This feature cannot be used with fundamental types.
 
 To see a full example of this feature, please check out
 test/test_Data_Type.cpp.
 
-\section motivation Motivation
+# Motivation {#motivation}
 
 There are a number of common problems when writing C or C++ extensions
 for Ruby:
 
-\li Type safety.  It is easy to mix-up integral types such as ID and
-VALUE.  Some of the functions in the Ruby API are not consistent with
+- Type safety. It is easy to mix-up integral types such as ID and
+VALUE. Some of the functions in the Ruby API are not consistent with
 which types they take (e.g. rb_const_defined takes an ID and
 rb_mod_remove_const takes a Symbol).
 
-\li DRY principle.  Specifying the number of arguments that each wrapped
-function takes is easy to get wrong.  Adding a new argument to the
+- DRY principle. Specifying the number of arguments that each wrapped
+function takes is easy to get wrong. Adding a new argument to the
 function means that the number of arguments passed to rb_define_method
 must also be updated.
 
-\li Type conversion.  There are many different functions to convert data
-to and from ruby types.  Many of them have different semantics or
-different forms.  For example, to convert a string, one might use the
+- Type conversion. There are many different functions to convert data
+to and from ruby types. Many of them have different semantics or
+different forms. For example, to convert a string, one might use the
 StringValue macro, but to convert a fixnum, one might use FIX2INT.
 Unwrapping previously wrapped C data uses yet another form.
 
-\li Exception safety.  It is imperative that C++ exceptions never make
+- Exception safety. It is imperative that C++ exceptions never make
 their way into C code, and it is also imperative that a Ruby exception
 never escape while there are objects on the stack with nontrivial
-destructors.  Rules for when it is okay to use which exceptions are
+destructors. Rules for when it is okay to use which exceptions are
 difficult to get right, especially as code is maintained through time.
 
-\li Thread safety.  Because the Ruby interpreter is not threads-safe,
+- Thread safety. Because the Ruby interpreter is not thread-safe,
 the Ruby interpreter must not be run from more than one thread.
 Because of tricks the GC and scheduler play with the C stack, it's not
 enough to ensure that only one thread runs the interpreter at any
 given time; once the interpreter has been run from one thread, it must
-only ever be run from that thread in the future.  Additionally,
+only ever be run from that thread in the future. Additionally,
 because Ruby copies the stack when it switches threads, C++ code must
 be careful not to access objects in one Ruby thread that were created
 on the stack in another Ruby thread.
 
-\li C-based API.  The Ruby API is not always convenient for accessing
+- C-based API. The Ruby API is not always convenient for accessing
 Ruby data structurs such as Hash and Array, especially when writing C++
 code, as the interface for these containers is not consistent with
 standard containers.
 
-\li Calling convention.  Function pointers passed into the Ruby API must
-follow the C calling convention.  This means that it is not possible to
+- Calling convention. Function pointers passed into the Ruby API must
+follow the C calling convention. This means that it is not possible to
 pass a pointer to a template function or static member function (that
 is, it will work on some platforms, but isn't portable).
 
-\li Inheritance.  When wrapping C++ objects, it is easy to store a
+- Inheritance. When wrapping C++ objects, it is easy to store a
 pointer to a derived class, but then methods in the base class must have
-knowledge of the derived class in order to unwrap the object.  It is
+knowledge of the derived class in order to unwrap the object. It is
 possible to always store a pointer to the base class and then
 dynamic_cast the pointer to the derived type when necessary, but this
 can be slow and cumbersome, and it isn't likely to work with multiple
-inheritance.  A system that properly handles inheritance for all corner
+inheritance. A system that properly handles inheritance for all corner
 cases is nontrivial.
 
-\li Multiple inheritance.  C++ supports true multiple inheritance, but
-the Ruby object model uses single inheritance with mixins.  When
+- Multiple inheritance. C++ supports true multiple inheritance, but
+the Ruby object model uses single inheritance with mixins. When
 wrapping a library whose public interface uses multiple inheritance,
 care must be taken in constructing the mapping.
 
-\li GC safety.  All live Ruby objects must be marked during the garbage
+- GC safety. All live Ruby objects must be marked during the garbage
 collector's mark phase, otherwise they will be prematurely destroyed.
 The general rule is that object references stored on the heap should be
 either registered with rb_gc_register_address or marked by a data
@@ -919,96 +916,96 @@ object's mark function; object references stored on the stack will be
 automatically marked, provided the Ruby interpreter was properly
 initialized at startup.
 
-\li Callbacks.  C implements callbacks via function pointers, while ruby
-typically implements callbacks via procs.  Writing an adapter function
+- Callbacks. C implements callbacks via function pointers, while Ruby
+typically implements callbacks via procs. Writing an adapter function
 to call the proc is not difficult, but there is much opportunity for
 error (particularly with exception-safety).
 
-\li Data serialization.  By default data objects defined at the C layer
-are not marshalable.  The user must explicitly define functions to
+- Data serialization. By default data objects defined at the C layer
+are not marshalable. The user must explicitly define functions to
 marshal the data member-by-member.
 
 Rice addresses these issues in many ways:
 
-\li Type safety.  Rice provides encapsulation for all builtin types,
-such as Object, Identifier, Class, Module, and String.  It
+- Type safety. Rice provides encapsulation for all builtin types,
+such as Object, Identifier, Class, Module, and String. It
 automatically checks the dynamic type of an object before constructing
 an instance of a wrapper.
 
-\li DRY principle.  Rice uses introspection through the use of templates
+- DRY principle. Rice uses introspection through the use of templates
 and function overloading to automatically determine the number and types
-of arguments to functions.  Default arguments must still be handled
+of arguments to functions. Default arguments must still be handled
 explicitly, however.
 
-\li Type conversions.  Rice provides cast-style to_ruby<> and
+- Type conversions. Rice provides cast-style to_ruby<> and
 from_ruby<> template functions to simplify explicit type conversions.
 Automatic type conversions for parameters and return values are
 generated for all wrapped functions.
 
-\li Exception safety.  Rice automatically converts common exceptions and
-provides a mechanism for converting user-defined exception types.  Rice
+- Exception safety. Rice automatically converts common exceptions and
+provides a mechanism for converting user-defined exception types. Rice
 also provides convenience functions for converting exceptions when
 calling back into ruby code.
 
-\li Thread safety.  Rice provides no mechanisms for dealing with thread
-safety.  Many common thread safety issues should be alleviated by YARV,
+- Thread safety. Rice provides no mechanisms for dealing with thread
+safety. Many common thread safety issues should be alleviated by YARV,
 which supports POSIX threads.
 
-\li C++-based API.  Rice provides an object-oriented C++-style API to
+- C++-based API. Rice provides an object-oriented C++-style API to
 most common functions in the Ruby C API.
 
-\li Calling convention.  Rice automatically uses C calling convention
+- Calling convention. Rice automatically uses C calling convention
 for all function pointers passed into the Ruby API.
 
-\li Inheritance.  Rice provides automatic conversion to the base class
+- Inheritance. Rice provides automatic conversion to the base class
 type when a wrapped member function is called on the base class.
 
-\li Multiple inheritance.  Rice provides no mechanism for multiple
-inheritance.  Multiple inheritance can be simulated via mixins, though
+- Multiple inheritance. Rice provides no mechanism for multiple
+inheritance. Multiple inheritance can be simulated via mixins, though
 this is not yet as easy as it could be.
 
-\li GC safety.  Rice provides a handful of convenience classes for
-interacting with the garbage collector.  There are still basic rules
+- GC safety. Rice provides a handful of convenience classes for
+interacting with the garbage collector. There are still basic rules
 which must be followed to ensure that objects get properly destroyed.
 
-\li Callbacks.  Rice provides a handful of convenience classes for
+- Callbacks. Rice provides a handful of convenience classes for
 dealing with callbacks.
 
-\li Data serialization.  Rice provides no mechanism for data
+- Data serialization. Rice provides no mechanism for data
 serialization, but it is likely this may be added in a future release.
 
 
-\section what_not What Rice is Not
+# What Rice is Not {#what_not}
 
-There are a number projects which server similar functions to Rice.  Two
-such popular projects are SWIG and Boost.Python.  Rice has some
+There are a number projects which server similar functions to Rice. Two
+such popular projects are SWIG and Boost.Python. Rice has some
 distinct features which set it apart from both of these projects.
 
-Rice is not trying to replace SWIG.  Rice is not a generic wrapper
-interface generator.  Rice is a C++ library for interfacing with the
-Ruby C API.  This provides a very natural way for C++ programmers to
+Rice is not trying to replace SWIG. Rice is not a generic wrapper
+interface generator. Rice is a C++ library for interfacing with the
+Ruby C API. This provides a very natural way for C++ programmers to
 wrap their C++ code, without having to learn a new domain-specific
-language.  However, there is no reason why SWIG and Rice could not work
-together; a SWIG module could be written to generate Rice code.  Such a
+language. However, there is no reason why SWIG and Rice could not work
+together; a SWIG module could be written to generate Rice code. Such a
 module would combine the portability of SWIG with the maintainability of
 Rice (I have written extensions using both, and I have found Rice
 extensions to be more maintainable when the interface is constantly
-changing.  Your mileage may vary).
+changing. Your mileage may vary).
 
 Rice is also not trying to simply be a Ruby version of Boost.Python.
 Rice does use some of the same template tricks that Boost.Python uses,
-however there are some important distinctions.  First of all,
+however there are some important distinctions. First of all,
 Boost.Python attempts to create a declarative DSL in C++ using
-templates.  Rice is a wrapper around the Ruby C API and attempts to make
+templates. Rice is a wrapper around the Ruby C API and attempts to make
 its interface look like an OO version of the API; this means that class
-declarations look procedural rather than declarative.  Secondly, the
-Ruby object model is different from the python object model.  This is
+declarations look procedural rather than declarative. Secondly, the
+Ruby object model is different from the python object model. This is
 reflected in the interface to Rice; it mimics the Ruby object model at
-the C++ level.  Thirdly, Rice uses Ruby as a code generator; I find this
+the C++ level. Thirdly, Rice uses Ruby as a code generator; I find this
 to be much more readable than using the Boost preprocessor library.
 
 
-\section history History
+# History {#history}
 
 Rice originated as Excruby, a project to interface with C++-based trading
 software at Automated Trading Desk in Mount Pleasant, South Carolina.
@@ -1017,7 +1014,7 @@ today, and did not suit the needs of the project.
 
 Excruby was written not as a wrapper for the Ruby API, but rather as a
 set of helper functions and classes for interfacing with the Ruby
-interpreter in an exception-safe manner.  Over the course of five years,
+interpreter in an exception-safe manner. Over the course of five years,
 the project grew into wrappers for pieces of the API, but the original
 helper functions remained as part of the public interface.
 
@@ -1026,30 +1023,28 @@ multiple ways of accomplishing most tasks -- directly through the C API,
 through a low-level wrapper around the C API, and through a high-level
 abstraction of the lower-level interfaces.
 
-Rice was then born in an attempt to clean up the interface.  Rice keeps
+Rice was then born in an attempt to clean up the interface. Rice keeps
 the lower-level wrappers, but as an implementation detail; the public
 interface is truly a high-level abstraction around the Ruby C API.
 
 
-\section gc The GC
+# The GC {#gc}
 
-\li Objects are not automatically registered with the garbage collector.
+- Objects are not automatically registered with the garbage collector.
 
-\li If an Object is on the stack, it does not need to be registered with
+- If an Object is on the stack, it does not need to be registered with
 the garbage collector.
 
-\li If an Object is allocated on the heap or if it is a member of an
+- If an Object is allocated on the heap or if it is a member of an
 object that might be allocated on the heap, use an
 Rice::Address_Registration_Guard to register the object with the garbage
 collector.
 
-\li If a reference counted object is being wrapped, or if another type
+- If a reference counted object is being wrapped, or if another type
 of smart pointer is wrapped, ensure that only one mechanism is used to
-destroy the object.  In general, the smart pointer manages the
+destroy the object. In general, the smart pointer manages the
 allocation of the object, and Ruby should hold only a reference to the
-smart pointer.  When the garbage collector determines that it is time to
+smart pointer. When the garbage collector determines that it is time to
 clean up the object, the smart pointer will be destroyed, decrementing
 the reference count; when the reference count drops to 0, underlying
 object will be destroyed.
-
-vim:ft=cpp:tw=72:ts=2:sw=2:fo=cqrtn:noci:si