Doxygen::DoxygenParser Struct Reference

#include <doxygen_parser.h>

Collaboration diagram for Doxygen::DoxygenParser:

Public Member Functions
	DoxygenParser ()
int	FindNextKeyword (const wxString &doc)
int	GetArgument (const wxString &doc, int range, wxString &output)
int	GetPosition () const
void	ReplaceInDoc (wxString &doc, size_t start, size_t count, const wxString &str)
void	ReplaceCurrentKeyword (wxString &doc, const wxString &str)

Static Public Attributes
static const wxString	Keywords []
static const int	KwCount = sizeof(DoxygenParser::Keywords)/sizeof(DoxygenParser::Keywords[0])
static const wxString	NewLineReplacment = _T("\n")

Protected Member Functions
int	CheckKeyword (const wxString &doc)
int	GetParagraphArgument (const wxString &doc, wxString &output)
void	GetWordArgument (const wxString &doc, wxString &output)
void	GetBlockArgument (const wxString &doc, wxString &output)
int	GetLineArgument (const wxString &doc, wxString &output)
bool	IsKeywordBegin (const wxString &doc) const
bool	IsOneOf (wxChar c, const wxChar *chars) const
bool	IsEnd (const wxString &doc) const
int	GetEndLine (const wxString &doc) const
bool	SkipDecorations (const wxString &doc)
bool	HandleNewLine (const wxString &doc, wxString &output, const wxString &replaceWith=NewLineReplacment)

Protected Attributes
int	m_FoundKw
int	m_Pos

Detailed Description

Definition at line 69 of file doxygen_parser.h.

Constructor & Destructor Documentation

DoxygenParser()

Doxygen::DoxygenParser::DoxygenParser

(

)

Definition at line 77 of file doxygen_parser.cpp.

References Doxygen::KEYWORDS_COUNT, and KwCount.

Member Function Documentation

CheckKeyword()

int Doxygen::DoxygenParser::CheckKeyword ( const wxString &  doc )

protected

Definition at line 151 of file doxygen_parser.cpp.

References _T, IsOneOf(), Keywords, Doxygen::KEYWORDS_COUNT, KwCount, m_FoundKw, m_Pos, Doxygen::NO_KEYWORD, and wxString::size().

Referenced by FindNextKeyword(), and GetLineArgument().

FindNextKeyword()

int Doxygen::DoxygenParser::FindNextKeyword

(

const wxString &

doc

)

Definition at line 84 of file doxygen_parser.cpp.

References CheckKeyword(), IsKeywordBegin(), Doxygen::KEYWORDS_COUNT, m_Pos, Doxygen::NO_KEYWORD, and wxString::size().

Referenced by DocumentationHelper::DoxygenToHTML().

GetArgument()

int Doxygen::DoxygenParser::GetArgument	(	const wxString &	doc,
		int	range,
		wxString &	output
	)

Definition at line 101 of file doxygen_parser.cpp.

References GetBlockArgument(), GetLineArgument(), GetParagraphArgument(), GetWordArgument(), m_Pos, Doxygen::RANGE_BLOCK, Doxygen::RANGE_LINE, Doxygen::RANGE_PARAGRAPH, Doxygen::RANGE_WORD, and SkipDecorations().

Referenced by DocumentationHelper::DoxygenToHTML().

GetBlockArgument()

void Doxygen::DoxygenParser::GetBlockArgument ( const wxString &  doc, wxString &  output  )

protected

Definition at line 263 of file doxygen_parser.cpp.

Referenced by GetArgument().

GetEndLine()

int Doxygen::DoxygenParser::GetEndLine ( const wxString &  doc ) const

protected

Definition at line 349 of file doxygen_parser.cpp.

References _T, wxString::find(), m_Pos, wxString::npos, and wxString::size().

GetLineArgument()

int Doxygen::DoxygenParser::GetLineArgument ( const wxString &  doc, wxString &  output  )

protected

Definition at line 270 of file doxygen_parser.cpp.

References _T, CheckKeyword(), IsKeywordBegin(), m_Pos, Doxygen::NESTED_KEYWORDS_BEGIN, Doxygen::NO_KEYWORD, and wxString::size().

Referenced by GetArgument(), and GetParagraphArgument().

GetParagraphArgument()

int Doxygen::DoxygenParser::GetParagraphArgument ( const wxString &  doc, wxString &  output  )

protected

Definition at line 221 of file doxygen_parser.cpp.

References _T, GetLineArgument(), HandleNewLine(), m_Pos, and wxString::size().

Referenced by GetArgument().

GetPosition()

int Doxygen::DoxygenParser::GetPosition

(

)

const

Definition at line 127 of file doxygen_parser.cpp.

References m_Pos.

Referenced by DocumentationHelper::DoxygenToHTML().

GetWordArgument()

void Doxygen::DoxygenParser::GetWordArgument ( const wxString &  doc, wxString &  output  )

protected

Definition at line 239 of file doxygen_parser.cpp.

References _T, m_Pos, and wxString::size().

Referenced by GetArgument().

HandleNewLine()

bool Doxygen::DoxygenParser::HandleNewLine ( const wxString &  doc, wxString &  output, const wxString &  replaceWith = NewLineReplacment  )

protected

Returns

true if m_Pos has changed

Definition at line 370 of file doxygen_parser.cpp.

References SkipDecorations().

Referenced by GetParagraphArgument().

IsEnd()

bool Doxygen::DoxygenParser::IsEnd ( const wxString &  doc ) const

protected

Definition at line 344 of file doxygen_parser.cpp.

References m_Pos, and wxString::size().

Referenced by SkipDecorations().

IsKeywordBegin()

bool Doxygen::DoxygenParser::IsKeywordBegin ( const wxString &  doc ) const

protected

Definition at line 312 of file doxygen_parser.cpp.

References _T, and m_Pos.

Referenced by FindNextKeyword(), and GetLineArgument().

IsOneOf()

bool Doxygen::DoxygenParser::IsOneOf ( wxChar  c, const wxChar *  chars  ) const

protected

Definition at line 333 of file doxygen_parser.cpp.

Referenced by CheckKeyword(), and SkipDecorations().

ReplaceCurrentKeyword()

void Doxygen::DoxygenParser::ReplaceCurrentKeyword	(	wxString &	doc,
		const wxString &	str
	)

Definition at line 144 of file doxygen_parser.cpp.

References m_FoundKw, m_Pos, ReplaceInDoc(), and wxString::size().

Referenced by DocumentationHelper::DoxygenToHTML().

ReplaceInDoc()

void Doxygen::DoxygenParser::ReplaceInDoc	(	wxString &	doc,
		size_t	start,
		size_t	count,
		const wxString &	str
	)

Definition at line 132 of file doxygen_parser.cpp.

References m_Pos, wxString::replace(), and wxString::size().

Referenced by ReplaceCurrentKeyword().

SkipDecorations()

bool Doxygen::DoxygenParser::SkipDecorations ( const wxString &  doc )

protected

Returns

true if m_Pos has changed

Definition at line 357 of file doxygen_parser.cpp.

References _T, IsEnd(), IsOneOf(), and m_Pos.

Referenced by GetArgument(), and HandleNewLine().

Member Data Documentation

Keywords

const wxString Doxygen::DoxygenParser::Keywords

static

Initial value:

= {
        _T(""),                     
        _T("param"),                
        _T("return"), _T("result"), 
        _T("brief"), _T("short"),   
        _T("sa"), _T("see"),        

        
        _T("class"), _T("struct"),  
        _T("union"),                
        _T("enum"),                 
        _T("namespace"),            

        _T("fn"),                   
        _T("var"),                  
        _T("def"),                  

        _T("code"),                 
        _T("endcode"),              

        _T("b"),                    

    }

Definition at line 71 of file doxygen_parser.h.

Referenced by CheckKeyword().

KwCount

const int Doxygen::DoxygenParser::KwCount = sizeof(DoxygenParser::Keywords)/sizeof(DoxygenParser::Keywords[0])

static

Definition at line 72 of file doxygen_parser.h.

Referenced by CheckKeyword(), and DoxygenParser().

m_FoundKw

int Doxygen::DoxygenParser::m_FoundKw

protected

Definition at line 100 of file doxygen_parser.h.

Referenced by CheckKeyword(), and ReplaceCurrentKeyword().

m_Pos

int Doxygen::DoxygenParser::m_Pos

protected

Definition at line 101 of file doxygen_parser.h.

Referenced by CheckKeyword(), FindNextKeyword(), GetArgument(), GetEndLine(), GetLineArgument(), GetParagraphArgument(), GetPosition(), GetWordArgument(), IsEnd(), IsKeywordBegin(), ReplaceCurrentKeyword(), ReplaceInDoc(), and SkipDecorations().

NewLineReplacment

const wxString Doxygen::DoxygenParser::NewLineReplacment = _T("\n")

static

Definition at line 73 of file doxygen_parser.h.

---

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

• doxygen_parser.h
• doxygen_parser.cpp