GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | List of all members
comment_list Class Reference

#include "comment-list.h"

Inheritance diagram for comment_list:
base_list< comment_elt >

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)
 
comment_list * dup () const
 
comment_elt find_doc_comment () const
 
std::string find_doc_string () const
 
- Public Member Functions inherited from base_list< comment_elt >
 base_list ()=default
 
 base_list (const base_list &bl)=default
 
 base_list (const std::list< comment_elt > &l)
 
virtual ~base_list ()=default
 
void append (const comment_elt &s)
 
comment_elt & back ()
 
const comment_elt & back () const
 
iterator begin ()
 
const_iterator begin () const
 
void clear ()
 
bool empty () const
 
iterator end ()
 
const_iterator end () const
 
iterator erase (iterator pos)
 
comment_elt & front ()
 
const comment_elt & front () const
 
std::size_t length () const
 
base_list & operator= (const base_list &bl)=default
 
void pop_back ()
 
void pop_front ()
 
void push_back (const comment_elt &s)
 
void push_front (const comment_elt &s)
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
void remove_if (P pred)
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
std::size_t size () const
 

Additional Inherited Members

- Public Types inherited from base_list< comment_elt >
typedef std::list< comment_elt >::const_iterator const_iterator
 
typedef std::list< comment_elt >::const_reverse_iterator const_reverse_iterator
 
typedef std::list< comment_elt >::iterator iterator
 
typedef std::list< comment_elt >::reverse_iterator reverse_iterator
 
- Protected Attributes inherited from base_list< comment_elt >
std::list< comment_elt > m_lst
 

Detailed Description

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

Member Function Documentation

◆ append() [1/2]

void comment_list::append ( const comment_elt &  elt)
inline

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

References base_list< elt_type >::append().

Referenced by dup().

◆ 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 120 of file comment-list.h.

◆ dup()

comment_list * comment_list::dup ( void  ) const

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

References append().

◆ find_doc_comment()

comment_elt comment_list::find_doc_comment ( ) const
inline

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

Referenced by base_parser::make_function().

◆ find_doc_string()

std::string comment_list::find_doc_string ( ) const
inline

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

Referenced by base_parser::make_classdef(), and base_parser::make_script().

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