comment_list Class Reference

#include "comment-list.h"

Public Types
typedef std::list< comment_elt >::const_iterator	const_iterator
typedef std::list< comment_elt >::const_reference	const_reference
typedef std::list< comment_elt >::iterator	iterator
typedef std::list< comment_elt >::reference	reference

Public Member Functions
void	append (const comment_elt &elt)
void	append (const std::string &s, comment_elt::comment_type t=comment_elt::unknown, bool uses_hash_char=false)
reference	back ()
const_reference	back () const
iterator	begin ()
const_iterator	begin () const
void	clear ()
comment_list *	dup () const
bool	empty () const
iterator	end ()
const_iterator	end () const
comment_elt	find_doc_comment () const
std::string	find_doc_string () const
reference	front ()
const_reference	front () const

Detailed Description

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

Member Typedef Documentation

const_iterator

typedef std::list<comment_elt>::const_iterator comment_list::const_iterator

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

const_reference

typedef std::list<comment_elt>::const_reference comment_list::const_reference

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

iterator

typedef std::list<comment_elt>::iterator comment_list::iterator

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

reference

typedef std::list<comment_elt>::reference comment_list::reference

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

Member Function Documentation

append() [1/2]

void comment_list::append ( const comment_elt &  elt )

inline

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

append() [2/2]

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

inline

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

back() [1/2]

reference comment_list::back ( )

inline

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

back() [2/2]

const_reference comment_list::back ( ) const

inline

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

begin() [1/2]

iterator comment_list::begin ( )

inline

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

begin() [2/2]

const_iterator comment_list::begin ( ) const

inline

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

clear()

void comment_list::clear ( )

inline

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

Referenced by base_lexer::get_comment_list().

dup()

comment_list * comment_list::dup

(

)

const

Definition at line 38 of file comment-list.cc.

empty()

bool comment_list::empty ( ) const

inline

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

Referenced by base_parser::make_classdef_properties_block(), base_parser::make_function(), and tree_print_code::visit_octave_user_function_header().

end() [1/2]

iterator comment_list::end ( )

inline

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

end() [2/2]

const_iterator comment_list::end ( ) const

inline

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

find_doc_comment()

comment_elt comment_list::find_doc_comment ( ) const

inline

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

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

find_doc_string()

std::string comment_list::find_doc_string ( ) const

inline

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

References find_doc_comment(), and comment_elt::text().

Referenced by base_parser::make_script().

front() [1/2]

reference comment_list::front ( )

inline

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

Referenced by base_parser::make_classdef_properties_block().

front() [2/2]

const_reference comment_list::front ( ) const

inline

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

---

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

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