You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If I use block comment, =begin and =end delimiters are part of the documentation, and they are interpreted as headings h1:
example_class.rb
=beginThis is documentation=endclassExampleClass;end
This
rdoc example_class.rb
will generate the documentation with heading (h1) "begin" at the beginning and heading "end" at the end.
<h1id="class-ExampleClass" class="class">
class ExampleClass
</h1><sectionclass="description"><h1id="class-ExampleClass-label-begin">
begin
<span><ahref="#class-ExampleClass-label-begin">¶</a><ahref="#top">↑</a></span></h1><p>This is documentation</p><h1id="class-ExampleClass-label-end">
end
<span><ahref="#class-ExampleClass-label-end">¶</a><ahref="#top">↑</a></span></h1></section>
=begin and =end are just comment delimiters and should not be a part of the documentation.
I'm using version 6.0.1 (ruby 2.5)
The text was updated successfully, but these errors were encountered:
If I use block comment,
=begin
and=end
delimiters are part of the documentation, and they are interpreted as headingsh1
:example_class.rb
This
will generate the documentation with heading (h1) "begin" at the beginning and heading "end" at the end.
=begin
and=end
are just comment delimiters and should not be a part of the documentation.I'm using version 6.0.1 (ruby 2.5)
The text was updated successfully, but these errors were encountered: