octave::comment_elt Class Reference

#include "comment-list.h"

Collaboration diagram for octave::comment_elt:

Public Types
enum	comment_type {   unknown , block , full_line , end_of_line ,   doc_string , copyright }

Public Member Functions
	comment_elt (const comment_elt &oc)
	comment_elt (const std::string &s="", comment_type t=unknown)
	~comment_elt (void)=default
bool	is_block (void) const
bool	is_copyright (void) const
bool	is_doc_string (void) const
bool	is_end_of_line (void) const
bool	is_full_line (void) const
comment_elt &	operator= (const comment_elt &oc)
std::string	text (void) const
comment_type	type (void) const

Private Attributes
std::string	m_text
comment_type	m_type

Detailed Description

Definition at line 43 of file comment-list.h.

Member Enumeration Documentation

comment_type

enum octave::comment_elt::comment_type

Enumerator
unknown
block
full_line
end_of_line
doc_string
copyright

Definition at line 48 of file comment-list.h.

Constructor & Destructor Documentation

comment_elt() [1/2]

octave::comment_elt::comment_elt ( const std::string &  s = "", comment_type  t = unknown  )

inline

Definition at line 58 of file comment-list.h.

comment_elt() [2/2]

octave::comment_elt::comment_elt ( const comment_elt &  oc )

inline

Definition at line 61 of file comment-list.h.

~comment_elt()

octave::comment_elt::~comment_elt ( void  )

default

Member Function Documentation

is_block()

bool octave::comment_elt::is_block ( void  ) const

inline

Definition at line 79 of file comment-list.h.

Referenced by octave::check_for_doc_string().

is_copyright()

bool octave::comment_elt::is_copyright ( void  ) const

inline

Definition at line 83 of file comment-list.h.

is_doc_string()

bool octave::comment_elt::is_doc_string ( void  ) const

inline

Definition at line 82 of file comment-list.h.

is_end_of_line()

bool octave::comment_elt::is_end_of_line ( void  ) const

inline

Definition at line 81 of file comment-list.h.

Referenced by octave::base_parser::make_classdef_properties_block(), and octave_push_parse().

is_full_line()

bool octave::comment_elt::is_full_line ( void  ) const

inline

Definition at line 80 of file comment-list.h.

Referenced by octave::check_for_doc_string().

operator=()

comment_elt& octave::comment_elt::operator= ( const comment_elt &  oc )

inline

Definition at line 64 of file comment-list.h.

References m_text, and m_type.

text()

std::string octave::comment_elt::text ( void  ) const

inline

Definition at line 75 of file comment-list.h.

Referenced by octave::check_for_doc_string(), octave::tree_classdef_body::get_doc_string(), octave::base_parser::make_classdef_properties_block(), octave_push_parse(), and octave::tree_print_code::print_comment_elt().

type()

comment_type octave::comment_elt::type ( void  ) const

inline

Definition at line 77 of file comment-list.h.

Member Data Documentation

m_text

std::string octave::comment_elt::m_text

private

Definition at line 90 of file comment-list.h.

Referenced by operator=().

m_type

comment_type octave::comment_elt::m_type

private

Definition at line 93 of file comment-list.h.

Referenced by operator=().

---

The documentation for this class was generated from the following file:

• libinterp/parse-tree/comment-list.h