Bug #8157

How to write document for __LINE__, __FILE__, __END__

Added by Yui NARUSE about 1 year ago. Updated 11 months ago.

[ruby-core:53677]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:lib
Target version:-
ruby -v:ruby 2.1.0dev (2013-03-24 trunk 39888) [x86_64-freebsd9.1] Backport:

Description

How do I write document for LINE, FILE, END ?

Moreover, __ is expressed as _ in rdoc.
How can I avoid it?

History

#1 Updated by Zachary Scott about 1 year ago

I think we will have to teach RDoc to understand these keywords.

If you want to reference them from another class or method, wrapping them in + should prevent RDoc from generating any extra markup, ie: +FILE+

#2 Updated by Eric Hodel about 1 year ago

=begin
There is a conflict as "_" in RDoc means "emphasis". You can use slashes to escape, but it is a little ugly:

_FILE_

Maybe I can make whatever special in RDoc, I will try.

=end

#3 Updated by Zachary Scott 11 months ago

  • Status changed from Assigned to Closed

I've moved this to the RDoc tracker on github: https://github.com/rdoc/rdoc/issues/230

Also available in: Atom PDF