From e6e872b1e3d0e94b9ba71301a8d2f350eca142ab Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Fri, 25 Sep 2009 20:39:19 +0000 Subject: [PATCH] Doxygen update --- Cantera/src/thermo/Crystal.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Cantera/src/thermo/Crystal.h b/Cantera/src/thermo/Crystal.h index 009ee4857..efe4a8c3b 100644 --- a/Cantera/src/thermo/Crystal.h +++ b/Cantera/src/thermo/Crystal.h @@ -53,6 +53,16 @@ namespace Cantera { }; + //! Prints out the current internal state of the Crystal ThermoPhase object + /*! + * Example of usage: + * s << x << endl; + * + * @param s Reference to the ostream to write to + * @param x Object of type Crystal that you are querying + * + * @return Returns a reference to the ostream. + */ inline std::ostream& operator<<(std::ostream& s, Cantera::Crystal& x) { size_t ip; for (ip = 0; ip < x.nPhases(); ip++) {