DoxyBlocksConfig Class Reference

DoxyBlocks' configuration class. More...

#include <Config.h>

List of all members.

Public Member Functions
	DoxyBlocksConfig ()
	Constructor.
wxInt8	GetBlockComment () const
void	SetBlockComment (wxInt8 val)
wxInt8	GetLineComment () const
void	SetLineComment (wxInt8 val)
wxString	GetProjectNumber () const
void	SetProjectNumber (const wxString &val)
wxString	GetOutputDirectory () const
void	SetOutputDirectory (const wxString &val)
wxString	GetOutputLanguage () const
void	SetOutputLanguage (const wxString &val)
bool	GetUseAutoVersion () const
void	SetUseAutoVersion (bool val)
bool	GetExtractAll () const
void	SetExtractAll (bool val)
bool	GetExtractPrivate () const
void	SetExtractPrivate (bool val)
bool	GetExtractStatic () const
void	SetExtractStatic (bool val)
bool	GetWarnings () const
void	SetWarnings (bool val)
bool	GetWarnIfDocError () const
void	SetWarnIfDocError (bool val)
bool	GetWarnIfUndocumented () const
void	SetWarnIfUndocumented (bool val)
bool	GetWarnNoParamdoc () const
void	SetWarnNoParamdoc (bool val)
bool	GetAlphabeticalIndex () const
void	SetAlphabeticalIndex (bool val)
bool	GetGenerateHTML () const
void	SetGenerateHTML (bool val)
bool	GetGenerateHTMLHelp () const
void	SetGenerateHTMLHelp (bool val)
bool	GetGenerateCHI () const
void	SetGenerateCHI (bool val)
bool	GetBinaryTOC () const
void	SetBinaryTOC (bool val)
bool	GetGenerateLatex () const
void	SetGenerateLatex (bool val)
bool	GetGenerateRTF () const
void	SetGenerateRTF (bool val)
bool	GetGenerateMan () const
void	SetGenerateMan (bool val)
bool	GetGenerateXML () const
void	SetGenerateXML (bool val)
bool	GetGenerateAutogenDef () const
void	SetGenerateAutogenDef (bool val)
bool	GetGeneratePerlMod () const
void	SetGeneratePerlMod (bool val)
bool	GetEnablePreprocessing () const
void	SetEnablePreprocessing (bool val)
bool	GetClassDiagrams () const
void	SetClassDiagrams (bool val)
bool	GetHaveDot () const
void	SetHaveDot (bool val)
wxString	GetPathDoxygen () const
void	SetPathDoxygen (const wxString &val)
wxString	GetPathDoxywizard () const
void	SetPathDoxywizard (const wxString &val)
wxString	GetPathHHC () const
void	SetPathHHC (const wxString &val)
wxString	GetPathDot () const
void	SetPathDot (const wxString &val)
wxString	GetPathCHMViewer () const
void	SetPathCHMViewer (const wxString &val)
bool	GetOverwriteDoxyfile () const
void	SetOverwriteDoxyfile (bool val)
bool	GetPromptBeforeOverwriting () const
void	SetPromptBeforeOverwriting (bool val)
bool	GetUseAtInTags () const
void	SetUseAtInTags (bool val)
bool	GetUseInternalViewer () const
void	SetLoadTemplate (bool val)
bool	GetLoadTemplate () const
void	SetUseInternalViewer (bool val)
bool	GetRunHTML () const
void	SetRunHTML (bool val)
bool	GetRunCHM () const
void	SetRunCHM (bool val)
bool	ReadPrefsTemplate ()
	Read the settings template.
bool	WritePrefsTemplate ()
	Write the settings template.
wxString	GetCBConfigDir ()
	Get the global configuration directory path.
Private Member Functions
int	GetDefaultBlockComment () const
int	GetDefaultLineComment () const
wxString	GetDefaultProjectNumber () const
bool	GetDefaultUseAutoVersion () const
wxString	GetDefaultOutputDirectory () const
wxString	GetDefaultOutputLanguage () const
bool	GetDefaultExtractAll () const
bool	GetDefaultExtractPrivate () const
bool	GetDefaultExtractStatic () const
bool	GetDefaultWarnings () const
bool	GetDefaultWarnIfDocError () const
bool	GetDefaultWarnIfUndocumented () const
bool	GetDefaultWarnNoParamdoc () const
bool	GetDefaultAlphabeticalIndex () const
bool	GetDefaultGenerateHTML () const
bool	GetDefaultGenerateHTMLHelp () const
bool	GetDefaultGenerateCHI () const
bool	GetDefaultBinaryTOC () const
bool	GetDefaultGenerateLatex () const
bool	GetDefaultGenerateRTF () const
bool	GetDefaultGenerateMan () const
bool	GetDefaultGenerateXML () const
bool	GetDefaultGenerateAutogenDef () const
bool	GetDefaultGeneratePerlMod () const
bool	GetDefaultEnablePreprocessing () const
bool	GetDefaultClassDiagrams () const
bool	GetDefaultHaveDot () const
wxString	GetDefaultPathDoxygen () const
wxString	GetDefaultPathDoxywizard () const
wxString	GetDefaultPathHHC () const
wxString	GetDefaultPathDot () const
wxString	GetDefaultPathCHMViewer () const
bool	GetDefaultOverwriteDoxyfile () const
bool	GetDefaultPromptBeforeOverwriting () const
bool	GetDefaultUseAtInTags () const
bool	GetDefaultLoadTemplate () const
bool	GetDefaultUseInternalViewer () const
bool	GetDefaultRunHTML () const
bool	GetDefaultRunCHM () const
Private Attributes
wxInt8	m_iBlockComment
	Block comment type.
wxInt8	m_iLineComment
	Line comment type.
wxString	m_sProjectNumber
	Project Number.
wxString	m_sOutputDirectory
	Output Directory.
wxString	m_sOutputLanguage
	Output Language.
bool	m_bUseAutoVersion
	Use AutoVersion version number.
bool	m_bExtractAll
	Extract All.
bool	m_bExtractPrivate
	Extract Private.
bool	m_bExtractStatic
	Extract Static.
bool	m_bWarnings
	Warnings.
bool	m_bWarnIfDocError
	Warn If Doc Error.
bool	m_bWarnIfUndocumented
	Warn If Undocumented.
bool	m_bWarnNoParamdoc
	Warn No Paramdoc.
bool	m_bAlphabeticalIndex
	Alphabetical Index.
bool	m_bGenerateHTML
	Generate HTML.
bool	m_bGenerateHTMLHelp
	Generate HTML Help.
bool	m_bGenerateCHI
	Generate CHI.
bool	m_bBinaryTOC
	Generate Binary TOC.
bool	m_bGenerateLatex
	Generate Latex.
bool	m_bGenerateRTF
	Generate RTF.
bool	m_bGenerateMan
	Generate Man.
bool	m_bGenerateXML
	Generate XML.
bool	m_bGenerateAutogenDef
	Generate Autogen Def.
bool	m_bGeneratePerlMod
	Generate Perl Mod.
bool	m_bEnablePreprocessing
	Enable Preprocessing.
bool	m_bClassDiagrams
	Class Diagrams.
bool	m_bHaveDot
	Have Dot.
wxString	m_sPathDoxygen
	Path to Doxygen.
wxString	m_sPathDoxywizard
	Path to Doxywizard.
wxString	m_sPathHHC
	Path to HHC.
wxString	m_sPathDot
	Path to Dot.
wxString	m_sPathCHMViewer
	Path to CHM viewer.
bool	m_bOverwriteDoxyfile
	Overwrite the doxyfile.
bool	m_bPromptBeforeOverwriting
	Prompt before overwriting the doxyfile.
bool	m_bUseAtInTags
	Use @ in tags.
bool	m_bLoadTemplate
	Load settings template instead of using default settings.
bool	m_bUseInternalViewer
	Use internal viewer to display HTML.
bool	m_bRunHTML
	Run HTML after compilation.
bool	m_bRunCHM
	Run CHM after compilation.

---

Detailed Description

DoxyBlocks' configuration class.

---

Constructor & Destructor Documentation

DoxyBlocksConfig::DoxyBlocksConfig

(

)

Constructor.

Default constructor

Here is the call graph for this function:

---

Member Function Documentation

bool DoxyBlocksConfig::GetAlphabeticalIndex

(

)

const [inline]

Access m_bAlphabeticalIndex

Returns:

The current value of m_bAlphabeticalIndex

bool DoxyBlocksConfig::GetBinaryTOC

(

)

const [inline]

Access m_bBinaryTOC

Returns:

The current value of m_bBinaryTOC

wxInt8 DoxyBlocksConfig::GetBlockComment

(

)

const [inline]

Access m_iBlockComment

Returns:

The current value of m_iBlockComment

wxString DoxyBlocksConfig::GetCBConfigDir

(

)

Get the global configuration directory path.

Returns:

wxString The directory path with trailing separator.

bool DoxyBlocksConfig::GetClassDiagrams

(

)

const [inline]

Access m_bClassDiagrams

Returns:

The current value of m_bClassDiagrams

bool DoxyBlocksConfig::GetDefaultAlphabeticalIndex

(

)

const [inline, private]

Get the default value for m_bAlphabeticalIndex.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultBinaryTOC

(

)

const [inline, private]

Get the default value for m_bBinaryTOC.

Returns:

The default value.

int DoxyBlocksConfig::GetDefaultBlockComment

(

)

const [inline, private]

Get the default value for m_iBlockComment.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultClassDiagrams

(

)

const [inline, private]

Get the default value for m_bClassDiagrams.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultEnablePreprocessing

(

)

const [inline, private]

Get the default value for m_bEnablePreprocessing.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultExtractAll

(

)

const [inline, private]

Get the default value for m_bExtractAll.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultExtractPrivate

(

)

const [inline, private]

Get the default value for m_bExtractPrivate.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultExtractStatic

(

)

const [inline, private]

Get the default value for m_bExtractStatic.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateAutogenDef

(

)

const [inline, private]

Get the default value for m_bGenerateAutogenDef.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateCHI

(

)

const [inline, private]

Get the default value for m_bGenerateCHI.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateHTML

(

)

const [inline, private]

Get the default value for m_bGenerateHTML.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateHTMLHelp

(

)

const [inline, private]

Get the default value for m_bGenerateHTMLHelp.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateLatex

(

)

const [inline, private]

Get the default value for m_bGenerateLatex.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateMan

(

)

const [inline, private]

Get the default value for m_bGenerateMan.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGeneratePerlMod

(

)

const [inline, private]

Get the default value for m_bGeneratePerlMod.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateRTF

(

)

const [inline, private]

Get the default value for m_bGenerateRTF.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultGenerateXML

(

)

const [inline, private]

Get the default value for m_bGenerateXML.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultHaveDot

(

)

const [inline, private]

Get the default value for m_bHaveDot.

Returns:

The default value.

int DoxyBlocksConfig::GetDefaultLineComment

(

)

const [inline, private]

Get the default value for m_iLineComment.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultLoadTemplate

(

)

const [inline, private]

Get the default value for m_bLoadTemplate.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultOutputDirectory

(

)

const [inline, private]

Get the default value for m_sOutputDirectory.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultOutputLanguage

(

)

const [inline, private]

Get the default value for m_sOutputLanguage.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultOverwriteDoxyfile

(

)

const [inline, private]

Get the default value for m_bOverwriteDoxyfile.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultPathCHMViewer

(

)

const [inline, private]

Get the default value for m_sPathCHMViewer.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultPathDot

(

)

const [inline, private]

Get the default value for m_sPathDot.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultPathDoxygen

(

)

const [inline, private]

Get the default value for m_sPathDoxygen.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultPathDoxywizard

(

)

const [inline, private]

Get the default value for m_sPathDoxywizard.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultPathHHC

(

)

const [inline, private]

Get the default value for m_sPathHHC.

Returns:

The default value.

wxString DoxyBlocksConfig::GetDefaultProjectNumber

(

)

const [inline, private]

Get the default value for m_sProjectNumber.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultPromptBeforeOverwriting

(

)

const [inline, private]

Get the default value for m_bPromptBeforeOverwriting.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultRunCHM

(

)

const [inline, private]

Get the default value for m_bRunCHM.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultRunHTML

(

)

const [inline, private]

Get the default value for m_bRunHTML.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultUseAtInTags

(

)

const [inline, private]

Get the default value for m_bUseAtInTags.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultUseAutoVersion

(

)

const [inline, private]

Get the default value for m_bUseAutoVersion.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultUseInternalViewer

(

)

const [inline, private]

Get the default value for m_bUseInternalViewer.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultWarnIfDocError

(

)

const [inline, private]

Get the default value for m_bWarnIfDocError.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultWarnIfUndocumented

(

)

const [inline, private]

Get the default value for m_bWarnIfUndocumented.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultWarnings

(

)

const [inline, private]

Get the default value for m_bWarnings.

Returns:

The default value.

bool DoxyBlocksConfig::GetDefaultWarnNoParamdoc

(

)

const [inline, private]

Get the default value for m_bWarnNoParamdoc.

Returns:

The default value.

bool DoxyBlocksConfig::GetEnablePreprocessing

(

)

const [inline]

Access m_bEnablePreprocessing

Returns:

The current value of m_bEnablePreprocessing

bool DoxyBlocksConfig::GetExtractAll

(

)

const [inline]

Access m_bExtractAll

Returns:

The current value of m_bExtractAll

bool DoxyBlocksConfig::GetExtractPrivate

(

)

const [inline]

Access m_bExtractPrivate

Returns:

The current value of m_bExtractPrivate

bool DoxyBlocksConfig::GetExtractStatic

(

)

const [inline]

Access m_bExtractStatic

Returns:

The current value of m_bExtractStatic

bool DoxyBlocksConfig::GetGenerateAutogenDef

(

)

const [inline]

Access m_bGenerateAutogenDef

Returns:

The current value of m_bGenerateAutogenDef

bool DoxyBlocksConfig::GetGenerateCHI

(

)

const [inline]

Access m_bGenerateCHI

Returns:

The current value of m_bGenerateCHI

bool DoxyBlocksConfig::GetGenerateHTML

(

)

const [inline]

Access m_bGenerateHTML

Returns:

The current value of m_bGenerateHTML

bool DoxyBlocksConfig::GetGenerateHTMLHelp

(

)

const [inline]

Access m_bGenerateHTMLHelp

Returns:

The current value of m_bGenerateHTMLHelp

bool DoxyBlocksConfig::GetGenerateLatex

(

)

const [inline]

Access m_bGenerateLatex;

Returns:

The current value of m_bGenerateLatex;

bool DoxyBlocksConfig::GetGenerateMan

(

)

const [inline]

Access m_bGenerateMan

Returns:

The current value of m_bGenerateMan

bool DoxyBlocksConfig::GetGeneratePerlMod

(

)

const [inline]

Access m_bGeneratePerlMod

Returns:

The current value of m_bGeneratePerlMod

bool DoxyBlocksConfig::GetGenerateRTF

(

)

const [inline]

Access m_bGenerateRTF

Returns:

The current value of m_bGenerateRTF

bool DoxyBlocksConfig::GetGenerateXML

(

)

const [inline]

Access m_bGenerateXML

Returns:

The current value of m_bGenerateXML

bool DoxyBlocksConfig::GetHaveDot

(

)

const [inline]

Access m_bHaveDot

Returns:

The current value of m_bHaveDot

wxInt8 DoxyBlocksConfig::GetLineComment

(

)

const [inline]

Access m_iLineComment

Returns:

The current value of m_iLineComment

bool DoxyBlocksConfig::GetLoadTemplate

(

)

const [inline]

Access m_bLoadTemplate

Returns:

The current value of m_bLoadTemplate

wxString DoxyBlocksConfig::GetOutputDirectory

(

)

const [inline]

Access m_sOutputDirectory

Returns:

The current value of m_sOutputDirectory

wxString DoxyBlocksConfig::GetOutputLanguage

(

)

const [inline]

Access m_sOutputLanguage

Returns:

The current value of m_sOutputLanguage

bool DoxyBlocksConfig::GetOverwriteDoxyfile

(

)

const [inline]

Access m_bOverwriteDoxyfile

Returns:

The current value of m_bOverwriteDoxyfile

wxString DoxyBlocksConfig::GetPathCHMViewer

(

)

const [inline]

Access m_sPathCHMViewer

Returns:

The current value of m_sPathCHMViewer

wxString DoxyBlocksConfig::GetPathDot

(

)

const [inline]

Access m_sPathDot

Returns:

The current value of m_sPathDot

wxString DoxyBlocksConfig::GetPathDoxygen

(

)

const [inline]

Access m_sPathDoxygen

Returns:

The current value of m_sPathDoxygen

wxString DoxyBlocksConfig::GetPathDoxywizard

(

)

const [inline]

Access m_sPathDoxywizard

Returns:

The current value of m_sPathDoxywizard

wxString DoxyBlocksConfig::GetPathHHC

(

)

const [inline]

Access m_sPathHHC

Returns:

The current value of m_sPathHHC

wxString DoxyBlocksConfig::GetProjectNumber

(

)

const [inline]

Access m_sProjectNumber

Returns:

The current value of m_sProjectNumber

bool DoxyBlocksConfig::GetPromptBeforeOverwriting

(

)

const [inline]

Access m_bPromptBeforeOverwriting

Returns:

The current value of m_bPromptBeforeOverwriting

bool DoxyBlocksConfig::GetRunCHM

(

)

const [inline]

Access m_bRunCHM

Returns:

The current value of m_bRunCHM

bool DoxyBlocksConfig::GetRunHTML

(

)

const [inline]

Access m_bRunHTML

Returns:

The current value of m_bRunHTML

bool DoxyBlocksConfig::GetUseAtInTags

(

)

const [inline]

Access m_bUseAtInTags

Returns:

The current value of m_bUseAtInTags

bool DoxyBlocksConfig::GetUseAutoVersion

(

)

const [inline]

Access m_bUseAutoVersion

Returns:

The current value of m_bUseAutoVersion

bool DoxyBlocksConfig::GetUseInternalViewer

(

)

const [inline]

Access m_bUseInternalViewer

Returns:

The current value of m_bUseInternalViewer

bool DoxyBlocksConfig::GetWarnIfDocError

(

)

const [inline]

Access m_bWarnIfDocError

Returns:

The current value of m_bWarnIfDocError

bool DoxyBlocksConfig::GetWarnIfUndocumented

(

)

const [inline]

Access m_bWarnIfUndocumented

Returns:

The current value of m_bWarnIfUndocumented

bool DoxyBlocksConfig::GetWarnings

(

)

const [inline]

Access m_bWarnings

Returns:

The current value of m_bWarnings

bool DoxyBlocksConfig::GetWarnNoParamdoc

(

)

const [inline]

Access m_bWarnNoParamdoc

Returns:

The current value of m_bWarnNoParamdoc

bool DoxyBlocksConfig::ReadPrefsTemplate

(

)

Read the settings template.

Returns:

bool True if a template file was found, false otherwise.

This function looks for a settings template file in the global configuration directory for Code::Blocks and reads the data into the correct member variables. Default values are supplied for entries that don't contain values, although this should never happen unless the file is manually edited.

Here is the call graph for this function:

void DoxyBlocksConfig::SetAlphabeticalIndex

(

bool

val

)

[inline]

Set m_bAlphabeticalIndex

Parameters:

val

New value to set

void DoxyBlocksConfig::SetBinaryTOC

(

bool

val

)

[inline]

Set m_bBinaryTOC

Parameters:

val

New value to set

void DoxyBlocksConfig::SetBlockComment

(

wxInt8

val

)

[inline]

Set m_iBlockComment

Parameters:

val

New value to set

void DoxyBlocksConfig::SetClassDiagrams

(

bool

val

)

[inline]

Set m_bClassDiagrams

Parameters:

val

New value to set

void DoxyBlocksConfig::SetEnablePreprocessing

(

bool

val

)

[inline]

Set m_bEnablePreprocessing

Parameters:

val

New value to set

void DoxyBlocksConfig::SetExtractAll

(

bool

val

)

[inline]

Set m_bExtractAll

Parameters:

val

New value to set

void DoxyBlocksConfig::SetExtractPrivate

(

bool

val

)

[inline]

Set m_bExtractPrivate

Parameters:

val

New value to set

void DoxyBlocksConfig::SetExtractStatic

(

bool

val

)

[inline]

Set m_bExtractStatic

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateAutogenDef

(

bool

val

)

[inline]

Set m_bGenerateAutogenDef

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateCHI

(

bool

val

)

[inline]

Set m_bGenerateCHI

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateHTML

(

bool

val

)

[inline]

Set m_bGenerateHTML

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateHTMLHelp

(

bool

val

)

[inline]

Set m_bGenerateHTMLHelp

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateLatex

(

bool

val

)

[inline]

Set m_bGenerateLatex;

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateMan

(

bool

val

)

[inline]

Set m_bGenerateMan

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGeneratePerlMod

(

bool

val

)

[inline]

Set m_bGeneratePerlMod

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateRTF

(

bool

val

)

[inline]

Set m_bGenerateRTF

Parameters:

val

New value to set

void DoxyBlocksConfig::SetGenerateXML

(

bool

val

)

[inline]

Set m_bGenerateXML

Parameters:

val

New value to set

void DoxyBlocksConfig::SetHaveDot

(

bool

val

)

[inline]

Set m_bHaveDot

Parameters:

val

New value to set

void DoxyBlocksConfig::SetLineComment

(

wxInt8

val

)

[inline]

Set m_iLineComment

Parameters:

val

New value to set

void DoxyBlocksConfig::SetLoadTemplate

(

bool

val

)

[inline]

Set m_bLoadTemplate

Parameters:

val

New value to set

void DoxyBlocksConfig::SetOutputDirectory

(

const wxString &

val

)

[inline]

Set m_sOutputDirectory

Parameters:

val

New value to set

void DoxyBlocksConfig::SetOutputLanguage

(

const wxString &

val

)

[inline]

Set m_sOutputLanguage

Parameters:

val

New value to set

void DoxyBlocksConfig::SetOverwriteDoxyfile

(

bool

val

)

[inline]

Set m_bOverwriteDoxyfile

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPathCHMViewer

(

const wxString &

val

)

[inline]

Set m_sPathCHMViewer

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPathDot

(

const wxString &

val

)

[inline]

Set m_sPathDot

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPathDoxygen

(

const wxString &

val

)

[inline]

Set m_sPathDoxygen

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPathDoxywizard

(

const wxString &

val

)

[inline]

Set m_sPathDoxywizard

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPathHHC

(

const wxString &

val

)

[inline]

Set m_sPathHHC

Parameters:

val

New value to set

void DoxyBlocksConfig::SetProjectNumber

(

const wxString &

val

)

[inline]

Set m_sProjectNumber

Parameters:

val

New value to set

void DoxyBlocksConfig::SetPromptBeforeOverwriting

(

bool

val

)

[inline]

Set m_bPromptBeforeOverwriting

Parameters:

val

New value to set

void DoxyBlocksConfig::SetRunCHM

(

bool

val

)

[inline]

Set m_bRunCHM

Parameters:

val

New value to set

void DoxyBlocksConfig::SetRunHTML

(

bool

val

)

[inline]

Set m_bRunHTML

Parameters:

val

New value to set

void DoxyBlocksConfig::SetUseAtInTags

(

bool

val

)

[inline]

Set m_bUseAtInTags

Parameters:

val

New value to set

void DoxyBlocksConfig::SetUseAutoVersion

(

bool

val

)

[inline]

Set m_bUseAutoVersion

Parameters:

val

New value to set

void DoxyBlocksConfig::SetUseInternalViewer

(

bool

val

)

[inline]

Set m_bUseInternalViewer

Parameters:

val

New value to set

void DoxyBlocksConfig::SetWarnIfDocError

(

bool

val

)

[inline]

Set m_bWarnIfDocError

Parameters:

val

New value to set

void DoxyBlocksConfig::SetWarnIfUndocumented

(

bool

val

)

[inline]

Set m_bWarnIfUndocumented

Parameters:

val

New value to set

void DoxyBlocksConfig::SetWarnings

(

bool

val

)

[inline]

Set m_bWarnings

Parameters:

val

New value to set

void DoxyBlocksConfig::SetWarnNoParamdoc

(

bool

val

)

[inline]

Set m_bWarnNoParamdoc

Parameters:

val

New value to set

bool DoxyBlocksConfig::WritePrefsTemplate

(

)

Write the settings template.

Returns:

bool True if the data is flushed to the file successfully, false otherwise.

This function looks for a settings template file in the global configuration directory for Code::Blocks. If not found, it creates a new file. It then writes the current values of the data member variables to the file. Since default values are supplied when this class is instantiated, the data members should always contain valid values.

Here is the call graph for this function:

---

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

• Config.h
• Config.cpp