CommentList Class Reference

#include <comment_list.h>

Public Member Functions
void	addComment (const String &comment, int visible=0, bool wikiVerbatim=false)
void	addComment (const char *comment, bool verbatim=false)
void	clear ()
size_t	size () const

Public Attributes
StringVector	comments
std::vector< int >	visibility
std::vector< bool >	wikiVerbatim

Detailed Description

Just a class for holding comments

Definition at line 32 of file comment_list.h.

Member Function Documentation

addComment() [1/2]

void CommentList::addComment	(	const String &	comment,
		int	visible = 0,
		bool	wikiVerbatim = false
	)

Definition at line 28 of file comment_list.cpp.

{
    comments.push_back(comment);
    visibility.push_back(visible);
    wikiVerbatim.push_back(verbatim);
}

addComment() [2/2]

void CommentList::addComment	(	const char *	comment,
		bool	verbatim = false
	)

Definition at line 34 of file comment_list.cpp.

{
    size_t t=0;
    while(comment[t]=='+' && comment[t]!='\0')
        t++;
    addComment(comment+t,t,verbatim);
}

clear()

void CommentList::clear

(

)

Definition at line 42 of file comment_list.cpp.

{
    comments.clear();
    visibility.clear();
    wikiVerbatim.clear();
}

size()

size_t CommentList::size

(

)

const

Definition at line 48 of file comment_list.cpp.

{
    return comments.size();
}

Member Data Documentation

comments

StringVector CommentList::comments

Definition at line 35 of file comment_list.h.

visibility

std::vector<int> CommentList::visibility

Definition at line 36 of file comment_list.h.

wikiVerbatim

std::vector<bool> CommentList::wikiVerbatim

Definition at line 37 of file comment_list.h.

---

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

• xmippCore/core/comment_list.h
• xmippCore/core/comment_list.cpp