]> git.wincent.com - wikitext.git/commitdiff
Remove RDoc hack notes; we're switching to YARD
authorWincent Colaiuta <win@wincent.com>
Sun, 13 Jun 2010 17:25:37 +0000 (19:25 +0200)
committerWincent Colaiuta <win@wincent.com>
Sun, 13 Jun 2010 17:25:37 +0000 (19:25 +0200)
Signed-off-by: Wincent Colaiuta <win@wincent.com>
doc/rdoc.rb

index 32c3722b6ceab2bf0e59d29a3b9a013fe36b2984..b140cb3ac7849b093ca2baa4aa3d727b26709f32 100644 (file)
@@ -1,25 +1,3 @@
-def notes #:nodoc: all
-  # This file is a terrible hack to get around RDoc's problems parsing C
-  # source files.
-  #
-  # The first problem is that it doesn't allow you to place documentation
-  # in header files; it has to be in the implementation file. While this
-  # is fine for Ruby code (which doesn't have headers) it's not really
-  # appropriate for C and the C "ethos".
-  #
-  # The second problem is that it can't handle documentation split across
-  # multiple source files. I tried to get around this by sticking all of
-  # the documentation in one file and hiding it inside a couple of
-  # preprocessor directives, but RDoc's parser is too brittle to cope
-  # with that; getting the documentation to appear next to the
-  # corresponding methods was a delicate balancing act that was too
-  # fiddly and cumbersome to be maintainable in the long run.
-  #
-  # This file is the somewhat ugly solution: we set up a phoney Ruby file
-  # and write all our documentation in that; RDoc can parse Ruby code
-  # adequately, it would seem.
-end
-
 # The Wikitext module provides a namespace for all of the extension.
 # In practice, all your interaction will be with the Wikitext::Parser
 # class.