From 994c9d1afbe7089d7bfea78739ec4f5e7a907eb0 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Sat, 16 Apr 2016 23:55:51 -0400 Subject: [PATCH] [CTML] Deprecate addInteger and CTML_Version --- include/cantera/base/ctml.h | 10 +++------- src/base/ctml.cpp | 1 + 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/include/cantera/base/ctml.h b/include/cantera/base/ctml.h index 384d60956..ae810412e 100644 --- a/include/cantera/base/ctml.h +++ b/include/cantera/base/ctml.h @@ -18,7 +18,7 @@ class Array2D; //! const Specifying the CTML version number /*! - * @todo Codify what the CTML_Version number means. + * @deprecated Unused. To be removed after Cantera 2.3. */ const std::string CTML_Version = "1.4.1"; @@ -55,10 +55,7 @@ const std::string CTML_Version = "1.4.1"; * have an empty string. * @param typeString String type. This is an optional parameter. The default * is to have an empty string. - * - * @todo I don't think this is used. Figure out what is used for writing - * integers, and codify that. unitsString shouldn't be here, since it's an - * int. typeString should be codified as to its usage. + * @deprecated Unused. to be removed after Cantera 2.3. */ void addInteger(XML_Node& node, const std::string& titleString, const int value, const std::string& unitsString="", @@ -394,8 +391,7 @@ void getMatrixValues(const XML_Node& node, * Returns a std::map containing a keyed values for child XML_Nodes of the * current node with the name, "integer". In the keyed mapping there will be a * list of titles vs. values for all of the XML nodes. The integer XML_nodes - * are expected to be in a particular form created by the function - * addInteger(). One value per XML_node is expected. + * are expected to be in a particular form, with one value per XML_node. * * Example: * @code diff --git a/src/base/ctml.cpp b/src/base/ctml.cpp index d26f6bcb4..63af5f096 100644 --- a/src/base/ctml.cpp +++ b/src/base/ctml.cpp @@ -17,6 +17,7 @@ std::string FP_Format = "%23.15E"; void addInteger(XML_Node& node, const std::string& title, const int val, const std::string& units, const std::string& type) { + warn_deprecated("addInteger", "Unused. To be removed after Cantera 2.3."); XML_Node& f = node.addChild(title, val); f.addAttribute("vtype", "integer"); if (type != "") {