DOCU: add date of deprecation to deprecated methods/classes

This commit is contained in:
Mark Olesen
2010-02-17 12:48:19 +01:00
parent 689d4b2860
commit 7425942742
6 changed files with 11 additions and 7 deletions

View File

@ -224,7 +224,7 @@ public:
inline T argRead(const label index) const; inline T argRead(const label index) const;
//- Return arguments that are additional to the executable //- Return arguments that are additional to the executable
// @deprecated use operator[] directly (Feb 2010) // @deprecated use operator[] directly (deprecated Feb 2010)
stringList::subList additionalArgs() const stringList::subList additionalArgs() const
{ {
return stringList::subList(args_, args_.size()-1, 1); return stringList::subList(args_, args_.size()-1, 1);

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd. \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
Deprecated Deprecated
This solver is present for backward-compatibility and the PBiCG solver This solver is present for backward-compatibility and the PBiCG solver
should be used instead. should be used instead. (deprecated Apr 2008)
SourceFiles SourceFiles
BICCG.C BICCG.C

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd. \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
Deprecated Deprecated
This solver is present for backward-compatibility and the PCG solver This solver is present for backward-compatibility and the PCG solver
should be used for preference. should be used for preference. (deprecated Apr 2008)
SourceFiles SourceFiles
ICCG.C ICCG.C

View File

@ -65,6 +65,7 @@ Deprecated
Specifying the local vectors as an @c axis (corresponding to e3) and a Specifying the local vectors as an @c axis (corresponding to e3) and a
@c direction (corresponding to e1), is allowed for backwards @c direction (corresponding to e1), is allowed for backwards
compatibility, but this terminology is generally a bit confusing. compatibility, but this terminology is generally a bit confusing.
(deprecated Apr 2008)
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -365,14 +365,14 @@ public:
} }
//- Return axis (e3: local Cartesian z-axis) //- Return axis (e3: local Cartesian z-axis)
// @deprecated method e3 is preferred // @deprecated method e3 is preferred (deprecated Apr 2008)
const vector& axis() const const vector& axis() const
{ {
return Rtr_.z(); return Rtr_.z();
} }
//- Return direction (e1: local Cartesian x-axis) //- Return direction (e1: local Cartesian x-axis)
// @deprecated method e1 is preferred // @deprecated method e1 is preferred (deprecated Apr 2008)
const vector& direction() const const vector& direction() const
{ {
return Rtr_.x(); return Rtr_.x();

View File

@ -29,6 +29,9 @@ Description
Reading of the (now deprecated and infrequently used) Reading of the (now deprecated and infrequently used)
Foam Trisurface Format. Foam Trisurface Format.
Deprecated
Other formats are better. (deprecated Mar 2009)
SourceFiles SourceFiles
FTRsurfaceFormat.C FTRsurfaceFormat.C