Class: Coradoc::AsciiDoc::Model::CommentLine

Inherits:

Base

• Object
• Lutaml::Model::Serializable
• Base
• Coradoc::AsciiDoc::Model::CommentLine

Defined in:

lib/coradoc/asciidoc/model/comment_line.rb

Overview

Single-line comment element for AsciiDoc documents.

Comment lines start with double slash (//) and are not included in the final document output.

Examples:

Create a comment line

comment = Coradoc::AsciiDoc::Model::CommentLine.new
comment.text = "This is a comment"
comment.to_adoc # => "// This is a comment\n"

See Also:

• Multi-line comments

Instance Attribute Summary

• #line_break ⇒ String readonly

  Line break character (default: “n”).

• #text ⇒ String readonly

  The comment text.

Attributes inherited from Base

#id

Method Summary

Methods inherited from Base

#block_level?, #inline?, #serialize_content, #simplify_block_content, #to_adoc, #to_h, visit, #visit

Instance Attribute Details

#line_break ⇒ String (readonly)

Returns Line break character (default: “n”).

Returns:

• (String) —

  Line break character (default: “n”)

# File 'lib/coradoc/asciidoc/model/comment_line.rb', line 24

class CommentLine < Base
  attribute :text, :string
  attribute :line_break, :string, default: -> { "\n" }
end

#text ⇒ String (readonly)

Returns The comment text.

Returns:

• (String) —

  The comment text

# File 'lib/coradoc/asciidoc/model/comment_line.rb', line 24

class CommentLine < Base
  attribute :text, :string
  attribute :line_break, :string, default: -> { "\n" }
end