Module: RGFA::Comments

Included in:
RGFA
Defined in:
lib/rgfa/comments.rb

Overview

Methods for the RGFA class, which allow to handle comment lines.

Instance Method Summary collapse

Instance Method Details

#comments ⇒ Array<RGFA::Line::Comment>

All comment lines of the graph

Returns:



24
25
26
 
# File 'lib/rgfa/comments.rb', line 24

def comments
  @comments
end

#delete_comment(cmt) ⇒ RGFA

Delete a comment line from the RGFA object

Parameters:

Returns:



17
18
19
20
 
# File 'lib/rgfa/comments.rb', line 17

def delete_comment(cmt)
  @comments.delete(cmt)
  return self
end

#delete_comments ⇒ RGFA

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Remove all comments.

Returns:



31
32
33
34
 
# File 'lib/rgfa/comments.rb', line 31

def delete_comments
  @comments = []
  return self
end