comment_elt Class Reference

#include "comment-list.h"

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

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

Detailed Description

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

Member Enumeration Documentation

comment_type

enum comment_elt::comment_type

Enumerator
unknown
block
full_line
end_of_line
copyright

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

Constructor & Destructor Documentation

comment_elt() [1/2]

comment_elt::comment_elt ( const std::string &  s = "", comment_type  t = unknown, bool  uses_hash_char = false  )

inline

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

comment_elt() [2/2]

comment_elt::comment_elt ( const comment_elt &  oc )

inline

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

~comment_elt()

comment_elt::~comment_elt ( )

default

Member Function Documentation

empty()

bool comment_elt::empty ( ) const

inline

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

Referenced by base_parser::make_function().

is_block()

bool comment_elt::is_block ( ) const

inline

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

is_copyright()

bool comment_elt::is_copyright ( ) const

inline

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

is_end_of_line()

bool comment_elt::is_end_of_line ( ) const

inline

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

Referenced by base_parser::make_classdef_properties_block().

is_full_line()

bool comment_elt::is_full_line ( ) const

inline

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

operator=()

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

inline

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

reset()

void comment_elt::reset ( )

inline

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

text()

std::string comment_elt::text ( ) const

inline

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

Referenced by comment_list::find_doc_string(), base_parser::make_classdef_properties_block(), and base_parser::make_function().

type()

comment_type comment_elt::type ( ) const

inline

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

uses_hash_char()

bool comment_elt::uses_hash_char ( ) const

inline

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

Referenced by base_parser::make_function().

---

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

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