v4 parser: fixed minor doxygen issues

git-svn-id: https://www.dynare.org/svn/dynare/dynare_v4@1075 ac1d8469-bf42-47a9-8791-bf33cf982152
time-shift
sebastien 2006-11-15 12:05:16 +00:00
parent f551a446b5
commit 211a839339
5 changed files with 15 additions and 12 deletions

View File

@ -202,7 +202,7 @@ OPTIMIZE_OUTPUT_JAVA = NO
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
BUILTIN_STL_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first

View File

@ -86,7 +86,7 @@ public :
//! Prints tmp1 and "stoch_simul(var_list_);" to output
void setStochSimul(std::string tmp1);
/*! Sets an option by printing
option_.<iName> = <iValue>
option_.iName = iValue
*/
void setOption(std::string iName, std::string iValue);
void setOption(std::string iName, std::string iValue1, std::string iValue2);
@ -95,7 +95,7 @@ public :
void runRplot(std::string);
/*! Prints some estimation initialisation */
void setEstimationInit(void);
//! Prints optimization options */
//! Prints optimization options
void setOptimOptions(std::string str1, std::string str2, int task);
/*! Prints estimated elements */
void setEstimatedElements(void);
@ -113,11 +113,13 @@ public :
void setCalibAc(std::string, std::string, std::string, std::string);
void runCalib(int);
// write "osr(var_list_,osr_params_,optim_weights_);"
//! Prints "osr(var_list_,osr_params_,optim_weights_);"
void setOsrParams(std::string);
void runOsr(std::string);
// writes "olr(var_list_,olr_inst_,obj_var_,optim_weights_);"
//! Prints "olr(var_list_,olr_inst_,obj_var_,optim_weights_);"
void setOlrInst(std::string);
void runOlr(std::string);

View File

@ -28,9 +28,9 @@ public :
/*! Destructor */
~OutputFile();
/*! Opens a given file and writes some initialization */
void Open(string iFileName);
void Open(std::string iFileName);
/*! Writes output data from SymbolTable and passed strings to output file */
void Save(ostringstream& iOutput);
void Save(std::ostringstream& iOutput);
};
//------------------------------------------------------------------------------
#endif

View File

@ -32,7 +32,7 @@ private :
std::string value;
};
/*!
\class ShockElement
\class Shock
\brief Shock Structure
*/
struct Shock

View File

@ -28,11 +28,12 @@ private :
/*! Adds symbol into symbol table
\param name a string.
\param type a Type struct.
\param tex_name a string for the TeX name.
\par Description
- warning if symbol is already set with same type \n
- error if symbol is already set with different type\n
- set Name and Type\n
- increase corresponding counter in ModelParameters class\n
- warning if symbol is already set with same type
- error if symbol is already set with different type
- set Name and Type
- increase corresponding counter in ModelParameters class
*/
static int AddSymbol(std::string name,Type type, std::string tex_name);
protected :