Code Monkey home page Code Monkey logo

Comments (3)

mfn avatar mfn commented on May 29, 2024

It seems part of the problem is processing of newlines. When I put an empty line between rdoc and the module definition (from the first example), it works:

require 'something'
=begin rdoc
findmeindoc
=end

module Foo
    class Bar
    end
end

gives

$ rdoc -v test2.rb
Parsing sources...
100% [ 1/ 1]  test2.rb
  class Foo::Bar (undocumented)
  module Foo

from rdoc.

mfn avatar mfn commented on May 29, 2024

When I modify the lexer to not consume the =end with the newline, it works:

$ diff -u ruby_lex.rb.orig ruby_lex.rb
--- ruby_lex.rb.orig    2011-05-31 02:46:43.000000000 +0200
+++ ruby_lex.rb 2011-05-31 02:46:50.000000000 +0200
@@ -409,6 +409,7 @@
       end

       gets # consume =end
+      ungetc

       @ltype = nil
       Token(TkCOMMENT, res)

Doesn't look like a clean fix though ...

from rdoc.

drbrain avatar drbrain commented on May 29, 2024

Thanks for the patch, it pointed me in th eright direction. Instead I changed the ruby parser to not assume that a TkCOMMENT is followed by a TkNL (newline).

Note that =begin and =end for documentation purposes is rarely used, commenting with # is preferred.

from rdoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.