Comments (3)
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.
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.
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)
- Incorrect module aliasing
- [Bug] Cannot insert a link after a left curly bracket appears HOT 1
- [Feature Request] Remove comments which starts with :no-doc
- [Bug] Symbol is modified when declared with %s HOT 1
- [Bug] rdoc doesn't detect heredoc comments HOT 1
- Unstable TestRDocGeneratorJsonIndex#test_generate test HOT 5
- Attributes not in methods TOC? HOT 3
- `rb_file_const` is not working
- Internationalize hardcoded rdoc-ref links
- rdoc non-determinism: module includes can be added once or twice to generated .ri
- Including modules creates an infinite loop between methods
- PLEASE make cross references actually work w/ ri HOT 6
- RDoc doesn't have complete files when being installed from git/github source HOT 6
- More documentation for methods in RDoc
- [Proposal] Add user guide, especially about directives HOT 3
- [Proposal] `bundle exec rdoc` command should work for rdoc itself HOT 4
- Bad performance during mixin resolution
- LoadError does not get automatically linked by RDoc
- `RDoc::Parser::ChangeLog` doesn't handle keep-a-changelog style CHANGELOG correctly
- HTML fragments in ri output
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rdoc.