Update of /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Compiler
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv19655
Modified Files:
Compiler-Option-Description.h
Log Message:
Updated documentation.
Index: Compiler-Option-Description.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/libcompbenchmarks/Compiler/Compiler-Option-Description.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** Compiler-Option-Description.h 16 Apr 2007 16:53:47 -0000 1.7
--- Compiler-Option-Description.h 1 May 2007 19:43:18 -0000 1.8
***************
*** 36,39 ****
--- 36,40 ----
/** \brief Interface helping to describe compiler' option.
+ *
* Compiler options can be described through XML files to provide both
* documentation to end-users and compatility related informations to
***************
*** 89,96 ****
virtual std::string Option(void);
virtual int CompilationTwoPassNeeded(void);
virtual int CompilationPass(void);
virtual std::string CompilationFirstPassOption(void);
-
virtual std::string Use(void);
--- 90,111 ----
virtual std::string Option(void);
+ /** \brief Detect two-passes' compilations
+ * \return Returns 1 if current option need two-passes */
virtual int CompilationTwoPassNeeded(void);
+
+ /** \brief Returns compilation-pass number
+ *
+ * This method should be called only if CompilationTwoPassNeeded() returns 1.
+ *
+ * \return integer (0, 1 or 2 at this time). */
virtual int CompilationPass(void);
+
+ /** \brief Returns related option in first pass
+ *
+ * When option is only meanful in a second pass, this method can be used
+ * to get related first-pass compilation option that makes it revelant.
+ *
+ * \return Related option in first-pass */
virtual std::string CompilationFirstPassOption(void);
virtual std::string Use(void);
***************
*** 99,106 ****
};
! /** \brief Interface to get and initialise known compiler's options' informations
* CBM::Compiler uses a CBM::CompilerOptionDescriptions instance to get
! * option descriptions for a given compiler/compiler's version and for analyzing
! * compatibility bettween options.
*/
class CompilerOptionDescriptions
--- 114,122 ----
};
! /** \brief Interface to get and initialize known compiler's options' informations
! *
* CBM::Compiler uses a CBM::CompilerOptionDescriptions instance to get
! * option descriptions from XML files for compiler/compiler's version and
! * to analyze compatibility bettween options.
*/
class CompilerOptionDescriptions
***************
*** 115,120 ****
protected:
! /** Parse a XML description file
! * \param _fileName XML file to parse */
virtual void parse(std::string _fileName);
--- 131,142 ----
protected:
! /** Parse a XML description file.
! *
! * This initialize internal structures and child CBM::CompilerOptionDescription
! * instances.
! *
! * \param _fileName XML file to parse
! * \sa Description()
! * \sa DescriptionNumber() */
virtual void parse(std::string _fileName);
***************
*** 126,129 ****
--- 148,153 ----
std::string _baseDir);
+ /** Retrive description file used
+ * \param std::string for description file name */
virtual std::string DescriptionFile(void);
***************
*** 136,149 ****
* \param _index Index of the description
* \return Option's description
! * \sa DescriptionNumber(); */
virtual CompilerOptionDescription *Description(int _index);
/** Returns a description by its id
* \param _id description's ID
! * \return Option's description */
virtual CompilerOptionDescription *Description(std::string _id);
virtual CompilerOptionDescription *DescriptionLitteral(std::string _litt);
virtual CBM_COM *Compiler(void);
--- 160,183 ----
* \param _index Index of the description
* \return Option's description
! * \sa DescriptionNumber()
! * \sa Description(std::string _id)
! * \sa DescriptionLitteral(std::string _litt) */
virtual CompilerOptionDescription *Description(int _index);
/** Returns a description by its id
* \param _id description's ID
! * \return Option's description
! * \sa Description(int _index)
! * \sa DescriptionLitteral(std::string _litt) */
virtual CompilerOptionDescription *Description(std::string _id);
+ /** Returns a description by its litteral option
+ * \return Option's description
+ * \sa Description(std::string _id)
+ * \sa Description(int _index) */
virtual CompilerOptionDescription *DescriptionLitteral(std::string _litt);
+ /** Retrieve associated compiler
+ * \return Compiler used to initialize descriptions */
virtual CBM_COM *Compiler(void);
***************
*** 151,155 ****
virtual ~CompilerOptionDescriptions();
};
-
}
--- 185,188 ----
|
