STYLE: more consistent formatting for deprecated items

- Start brief descriptions with 'Deprecated(YYYY-MM)' so that it is
  readily visible in the short method description. Consistent date
  format (YYYY-MM), placed immediately after the \deprecated tag.
This commit is contained in:
Mark Olesen
2018-11-11 17:17:33 +01:00
parent 91cfe4c271
commit ffec4c6fa7
27 changed files with 139 additions and 147 deletions

View File

@ -81,8 +81,9 @@ public:
//- Extract numbers from things like "-2.358-8" (same as "-2.358e-8")
static scalar readNasScalar(const std::string& str);
//- Extract numbers from things like "-2.358-8" (same as "-2.358e-8")
// \deprecated use readNasScalar instead (deprecated Sep 2017)
//- Deprecated(2017-09)
// Extract numbers from things like "-2.358-8" (same as "-2.358e-8")
// \deprecated(2017-09) - use readNasScalar() method
inline static scalar parseNASCoord(const std::string& str)
{
return readNasScalar(str);