doxygenコメント追加

git-svn-id: http://10.144.169.20/repos/um/branches/l7vsd-3.x-shamshel@5975 1ed66053-1c2d-0410-8867-f7571e6e31d3

diff --git a/parameter/parameter.cpp b/parameter/parameter.cpp
index 4f87f25..7a7cbdc 100644 (file)
--- a/parameter/parameter.cpp
+++ b/parameter/parameter.cpp
@@ -18,8 +18,7 @@ LOG_CATEGORY_TAG param_cat = LOG_CAT_L7VSD_PARAMETER;
 /*!
  * Constructor of Parameter class
  */
-l7vs::Parameter::Parameter()
-{
+l7vs::Parameter::Parameter(){
        if( !ParameterImpl::getInstance().init() ){
                LOGGER_PUT_LOG_FATAL( param_cat, 1, "Parameter initialize failure" );
                switch( param_cat ){
@@ -35,8 +34,7 @@ l7vs::Parameter::Parameter()
 /*!
  * Destructor of Parameter class
  */
-l7vs::Parameter::~Parameter()
-{
+l7vs::Parameter::~Parameter(){
 }
 
 /*!
@@ -45,8 +43,7 @@ l7vs::Parameter::~Parameter()
  * @return     true = success read file / false = failure read file
  */
 bool
-l7vs::Parameter::rereadFile(PARAMETER_COMPONENT_TAG comp)
-{
+l7vs::Parameter::rereadFile(PARAMETER_COMPONENT_TAG comp){
        return ParameterImpl::getInstance().rereadFile(comp);
 }
 
@@ -57,8 +54,7 @@ l7vs::Parameter::rereadFile(PARAMETER_COMPONENT_TAG comp)
  * @return     true = exist setting value / false = non exist setting value
  */
 bool
-l7vs::Parameter::isIntExist(const PARAMETER_COMPONENT_TAG comp, const std::string& key)
-{
+l7vs::Parameter::isIntExist(const PARAMETER_COMPONENT_TAG comp, const std::string& key){
        return ParameterImpl::getInstance().isIntExist(comp, key);
 }
 
@@ -69,8 +65,7 @@ l7vs::Parameter::isIntExist(const PARAMETER_COMPONENT_TAG comp, const std::strin
  * @return     true = exist setting value / false = non exist setting value
  */
 bool
-l7vs::Parameter::isStringExist(const PARAMETER_COMPONENT_TAG comp, const std::string& key)
-{
+l7vs::Parameter::isStringExist(const PARAMETER_COMPONENT_TAG comp, const std::string& key){
        return ParameterImpl::getInstance().isStringExist(comp, key);
 }
 
@@ -81,8 +76,7 @@ l7vs::Parameter::isStringExist(const PARAMETER_COMPONENT_TAG comp, const std::st
  * @return     value
  */
 int
-l7vs::Parameter::getIntValue(const PARAMETER_COMPONENT_TAG comp, const std::string& key)
-{
+l7vs::Parameter::getIntValue(const PARAMETER_COMPONENT_TAG comp, const std::string& key){
        return ParameterImpl::getInstance().getIntValue(comp, key);
 }
 
@@ -93,19 +87,7 @@ l7vs::Parameter::getIntValue(const PARAMETER_COMPONENT_TAG comp, const std::stri
  * @return     value
  */
 std::string
-l7vs::Parameter::getStringValue(const PARAMETER_COMPONENT_TAG comp, const std::string& key)
-{
+l7vs::Parameter::getStringValue(const PARAMETER_COMPONENT_TAG comp, const std::string& key){
        return ParameterImpl::getInstance().getStringValue(comp, key);
 }
 
-/*!
- * set-parameter function pointer relates component-tag
- * @param[in]  comp    section TAG
- * @param[in]  p_func  function pointer
- */
-void
-l7vs::Parameter::registerFunctionPointer(const PARAMETER_COMPONENT_TAG comp, void(*p_func)())
-{
-       ParameterImpl::getInstance().registerFunctionPointer(comp, p_func);
-}
-

diff --git a/parameter/parameter.h b/parameter/parameter.h
index 1a530c2..f8c3ee7 100644 (file)
--- a/parameter/parameter.h
+++ b/parameter/parameter.h
@@ -1,6 +1,6 @@
 //
-//     @file   parameter.h
-//     @brief  ultramonke-l7 parameter class
+//!    @file   parameter.h
+//!    @brief  ultramonke-l7 parameter class
 //
 //     copyright(c) sdy corporation.2008
 //     mail: n.nakai at sdy.co.jp
@@ -17,31 +17,49 @@
 #include "parameter_enum.h"
 
 namespace l7vs{
-       class ParameterImpl;
-
-       class Parameter{
-       protected:
-               static Parameter instance;
-               Parameter();
-               Parameter( const Parameter& );
-               Parameter&      operator=( const Parameter& );
-               ~Parameter();
-       public:
-               bool    rereadFile(const PARAMETER_COMPONENT_TAG);
-       
-               inline static   Parameter& getInstance(){
-                       return  instance;
-               }
-               bool    isIntExist(     const PARAMETER_COMPONENT_TAG,
-                                                       const std::string&);
-               bool    isStringExist(
-                                                       const PARAMETER_COMPONENT_TAG,
-                                                       const std::string&);
-               int             getIntValue(const PARAMETER_COMPONENT_TAG,
-                                                       const std::string&);
-               std::string     getStringValue(const PARAMETER_COMPONENT_TAG,
-                                                       const std::string&);
-       };
+
+
+//!    @class  Parameter
+//!    @brief  configure file controller
+//! @brief     set key to get value.
+class Parameter{
+public:
+       Parameter();                                                    //!< default constractor
+       ~Parameter();                                                   //!< default destractor
+
+       //! reload file function
+       //! @param[in] parameter conponent tag
+       //! @return true success file read
+       //!     @return false failer file read
+       bool    rereadFile(const PARAMETER_COMPONENT_TAG);
+
+       //! paramter cateogry int value exist
+       //! @param[in]  paramtercategory
+       //!     @param[in]      parameterkey
+       //! @return true parameter key is intvalue alive.
+       //! @return false parameter key is intvalue not alive
+       bool    isIntExist(     const PARAMETER_COMPONENT_TAG, const std::string&);
+
+       //! parameter category string value exist
+       //! @param[in]  paramatercategory
+       //!     @param[in]      parametekey
+       //! @return true parameter key is string value alive
+       //!     @return false parameter key is string value not alive
+       bool    isStringExist(  const PARAMETER_COMPONENT_TAG, const std::string&);
+
+       //! parameter int value getter
+       //! @param[in]  parametercategory
+       //!     @param[in]      parameter key
+       //!     @return intvalue
+       int             getIntValue(const PARAMETER_COMPONENT_TAG, const std::string&);
+
+       //! parameter string value getter
+       //! @param[in]  parametercategory
+       //!     @param[in]      parameter key
+       //!     @return string value
+       std::string     getStringValue(const PARAMETER_COMPONENT_TAG, const std::string&);
 };
+
+}      //namespace l7vs
        
 #endif //PARAMETER_H

diff --git a/parameter/parameter_enum.h b/parameter/parameter_enum.h
index 394344e..525f609 100644 (file)
--- a/parameter/parameter_enum.h
+++ b/parameter/parameter_enum.h
@@ -1,6 +1,6 @@
 //
-//     @file   parameter_enum.h
-//     @brief  ultramonke-l7 parameter enum prototype
+//!    @file   parameter_enum.h
+//!    @brief  ultramonke-l7 parameter enum prototype
 //
 //     copyright(c) sdy corporation.2008
 //     mail: n.nakai at sdy.co.jp
@@ -9,29 +9,27 @@
 //     Distributed under the Boost Software License, Version 1.0. (See accompanying
 //     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 //
-
 #ifndef PARAMETER_ENUM_H
 #define PARAMETER_ENUM_H
 
 namespace l7vs{
 
-enum PARAMETER_COMPONENT_TAG
-{
-       PARAM_COMP_NOCAT = 0,
-       PARAM_COMP_ALL,
-       PARAM_COMP_L7VSD,
-       PARAM_COMP_COMMAND,
-       PARAM_COMP_SESSION,
-       PARAM_COMP_VIRTUALSERVICE,
-       PARAM_COMP_SCHEDULEMODULE,
-       PARAM_COMP_PROTOCOLMODULE,
-       PARAM_COMP_MODULE,
-       PARAM_COMP_REPLICATION,
-       PARAM_COMP_LOGGER,
-       PARAM_COMP_L7VSADM,
-       PARAM_COMP_SNMPAGENT
+//! @enum      PARAMTER_COMPONENT_TAG
+//!    @brief  parameter key tags
+enum PARAMETER_COMPONENT_TAG {
+       PARAM_COMP_NOCAT = 0,           //!< parameter category is none
+       PARAM_COMP_ALL,                         //!< parameter category is all(caution! this category used l7vsadm and command)
+       PARAM_COMP_L7VSD,                       //!< parameter category is l7vsd
+       PARAM_COMP_COMMAND,                     //!< parameter category is command
+       PARAM_COMP_SESSION,                     //!< parameter category is session
+       PARAM_COMP_VIRTUALSERVICE,      //!< parameter category is virtualservice
+       PARAM_COMP_MODULE,                      //!< parameter category is module control
+       PARAM_COMP_REPLICATION,         //!< parameter category is replication
+       PARAM_COMP_LOGGER,                      //!< parameter category is logger
+       PARAM_COMP_L7VSADM,                     //!< parameter category is l7vsadm
+       PARAM_COMP_SNMPAGENT            //!< parameter category is snmpagent
 };
 
 }      //namespace l7vsd
-       
+
 #endif //PARAMETER_ENUM

diff --git a/parameter/parameter_wrapper.h b/parameter/parameter_wrapper.h
index 1a53e26..f69c597 100644 (file)
--- a/parameter/parameter_wrapper.h
+++ b/parameter/parameter_wrapper.h
@@ -23,7 +23,8 @@ namespace l7vs{
  * @return     true = exist setting value / false = non exist setting value
  */
 inline bool parameter_is_int_exist(const PARAMETER_COMPONENT_TAG comp, const char* key){
-       return Parameter::getInstance().isIntExist(comp, key));
+       Parameter       param;
+       return param.isIntExist( comp, key );
 }
 
 /*!
@@ -32,7 +33,8 @@ inline bool parameter_is_int_exist(const PARAMETER_COMPONENT_TAG comp, const cha
  * @param[in]  key             key string
  * @return     true = exist setting value / false = non exist setting value*/
 inline bool parameter_is_int_exist( const PARAMETER_COMPONENT_TAG comp, const std::string key ){
-       return Parameter::getInstance().isIntExist(comp,key));
+       Parameter       param;
+       return param.isIntExist( comp, key );
 */
 
 /*!
@@ -42,7 +44,8 @@ inline bool parameter_is_int_exist( const PARAMETER_COMPONENT_TAG comp, const st
  * @return     true = exist setting value / false = non exist setting value
  */
 inline bool parameter_is_char_exist(const PARAMETER_COMPONENT_TAG comp, const char* key){
-       return Parameter::getInstance().isStringExist(comp, key));
+       Parameter       param;
+       return param.isStringExist(comp, key));
 }
 
 /*!
@@ -51,36 +54,12 @@ inline bool parameter_is_char_exist(const PARAMETER_COMPONENT_TAG comp, const ch
  * @param[in]  *key    key string
  * @return     value
  */
-inline int parameter_get_int_value(const PARAMETER_COMPONENT_TAG comp, const char* key)
-{
+inline int parameter_get_int_value(const PARAMETER_COMPONENT_TAG comp, const char* key){
+       Parameter       param;
        return l7vs::Parameter::getInstance().getIntValue(comp, key);
 }
 
-/*!
- * get character data.
- * @param[in]  comp    section TAG
- * @param[in]  *key    key string
- * @return     value
- */
-inline const char* parameter_get_char_value(const PARAMETER_COMPONENT_TAG comp, const char* key)
-{
-       return (l7vs::Parameter::getInstance().getStringValue(comp, key)).c_str();
-}
-
-/*!
- * reload config file
- * @param[in]  comp    section TAG
- * @return     0 = success read file / -1 = failure read file
- */
-inline int parameter_reread_file(const PARAMETER_COMPONENT_TAG comp)
-{
-       if (l7vs::Parameter::getInstance().rereadFile(comp)) {
-               return 0;
-       }
-       return -1;
-}
-
-};     //namespace l7vs
+}      //namespace l7vs
 
 #endif //PARAMETER_WRAPPER