Menu
▾
▴
[Csp-commits] svn:csp r1722 - in trunk/CSP/csp/cspsim: . battlefield f16 stores
|
From: <sv...@ww...> - 2005-12-05 05:31:50
|
Author: mkrose Date: 2005-12-04 21:31:42 -0800 (Sun, 04 Dec 2005) New Revision: 1722 Modified: trunk/CSP/csp/cspsim/Bus.h trunk/CSP/csp/cspsim/ChannelMirror.h trunk/CSP/csp/cspsim/DoubleChannelMirror.cpp trunk/CSP/csp/cspsim/SConscript trunk/CSP/csp/cspsim/SmokeEffects.h trunk/CSP/csp/cspsim/battlefield/Battlefield.h trunk/CSP/csp/cspsim/f16/DataEntry.h trunk/CSP/csp/cspsim/f16/F16Engine.cpp trunk/CSP/csp/cspsim/f16/F16System.h trunk/CSP/csp/cspsim/stores/Stores.h Log: Port doxygen config and cleanup comments. Browse at: https://www.zerobar.net/viewcvs/viewcvs.cgi?view=rev&rev=1722 Modified: trunk/CSP/csp/cspsim/Bus.h =================================================================== --- trunk/CSP/csp/cspsim/Bus.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/Bus.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -40,6 +40,10 @@ * **/ +/** + * @namespace csp::bus + * @brief Namespace used for data channel identifiers. + */ #ifndef __CSPSIM_BUS_H__ #define __CSPSIM_BUS_H__ Modified: trunk/CSP/csp/cspsim/ChannelMirror.h =================================================================== --- trunk/CSP/csp/cspsim/ChannelMirror.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/ChannelMirror.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -17,7 +17,9 @@ // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -/** Interfaces for replicating data channels between remote clients. +/** + * @file CSPSim.cpp + * @brief Interfaces for replicating data channels between remote clients. * * Most of the important state of an object is contained its the data channels. * Replicating selected channels from a source object to remote mirrors of Modified: trunk/CSP/csp/cspsim/DoubleChannelMirror.cpp =================================================================== --- trunk/CSP/csp/cspsim/DoubleChannelMirror.cpp 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/DoubleChannelMirror.cpp 2005-12-05 05:31:42 UTC (rev 1722) @@ -17,8 +17,9 @@ // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -/** Channel mirror specializations for double-precision floating point - * channels. +/** + * @file DoubleChannelMirror.cpp + * @brief Channel mirror specializations for double-precision floating point channels. */ Modified: trunk/CSP/csp/cspsim/SConscript =================================================================== --- trunk/CSP/csp/cspsim/SConscript 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/SConscript 2005-12-05 05:31:42 UTC (rev 1722) @@ -172,3 +172,6 @@ cspsim = env.SharedLibrary('cspsim', INTERFACES + SOURCES, SHLIBPREFIX='_') Alias(['all', 'cspsim'], [cspsim]) +env.Documentation('#/cspsim/.dox', '#/cspsim/cspsim.dox', ['#/cspsim/*.h', '#/cspsim/*.cpp', '#/cspsim/*/*.h', '#/cspsim/*/*.cpp']) + + Modified: trunk/CSP/csp/cspsim/SmokeEffects.h =================================================================== --- trunk/CSP/csp/cspsim/SmokeEffects.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/SmokeEffects.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -22,6 +22,10 @@ * **/ +/** + * @namespace csp::fx + * @brief 3D special effects. + */ #ifndef __CSPSIM_SMOKEEFFECTS_H__ #define __CSPSIM_SMOKEEFFECTS_H__ Modified: trunk/CSP/csp/cspsim/battlefield/Battlefield.h =================================================================== --- trunk/CSP/csp/cspsim/battlefield/Battlefield.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/battlefield/Battlefield.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -171,7 +171,7 @@ inline bool operator==(Object const &o) { return id() == o->id(); } inline bool operator!=(Object const &o) { return id() != o->id(); } - /** Get the (simdata object) path for this object. The path uniquely identifies the + /** Get the (csplib object) path for this object. The path uniquely identifies the * object type, and can used to construct an instance of the object. */ inline const Path path() const { return m_Path; } Modified: trunk/CSP/csp/cspsim/f16/DataEntry.h =================================================================== --- trunk/CSP/csp/cspsim/f16/DataEntry.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/f16/DataEntry.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -156,7 +156,7 @@ // links between channels. for example read(A) returns Alist[B] via a pull callback, // such that write(B) will change the output of the next call to read(A). // -// the second drawback concerns data-driven programming. simdata provides fairly +// the second drawback concerns data-driven programming. csplib provides fairly // powerful ways to connect objects together at runtime based on external data. // for some systems it would be very nice to provide only very basic class types // than can then be connected in non-trivial ways via xml. for example, the f-16 @@ -166,7 +166,7 @@ // hard codes the widget layout and static text it displays. this works but requires // code changes to modify the layout and add new pages. an attractive alternative // would be to write a single, generic interface page that gets its layout from an -// xml definition via simdata. specifying static text this way is easy, but +// xml definition via csplib. specifying static text this way is easy, but // connecting input widgets to the bus is difficult unless all the channels of // interest are primitive types. for example, an elevation entry widget can take // a single channel input of type double (or int), but that requires every system Modified: trunk/CSP/csp/cspsim/f16/F16Engine.cpp =================================================================== --- trunk/CSP/csp/cspsim/f16/F16Engine.cpp 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/f16/F16Engine.cpp 2005-12-05 05:31:42 UTC (rev 1722) @@ -259,7 +259,7 @@ m_CoreTemperatureTarget = m_FanTurbineInletTemperatureTarget * m_CoreFanTurbineInletTemperatureRatio; } -// TODO fix simdata random interface to provide obvious functions like this! +// TODO fix csplib random interface to provide obvious functions like this! double gauss(double mean, double sigma) { return static_cast<double>(rd::BoxMueller(g_Random, mean, sigma)); } Modified: trunk/CSP/csp/cspsim/f16/F16System.h =================================================================== --- trunk/CSP/csp/cspsim/f16/F16System.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/f16/F16System.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -22,6 +22,10 @@ * **/ +/** + * @namespace csp::f16 + * @brief F16 systems implementation. + */ #ifndef __CSPSIM_F16_F16SYSTEM_H__ #define __CSPSIM_F16_F16SYSTEM_H__ Modified: trunk/CSP/csp/cspsim/stores/Stores.h =================================================================== --- trunk/CSP/csp/cspsim/stores/Stores.h 2005-12-05 05:27:07 UTC (rev 1721) +++ trunk/CSP/csp/cspsim/stores/Stores.h 2005-12-05 05:31:42 UTC (rev 1722) @@ -432,9 +432,9 @@ RackMount(): m_Attitude(Quat::IDENTITY), m_Fixed(false) { } - // XXX simdata should not zero m_Attitude when the xml tag is not set. + // XXX csplib should not zero m_Attitude when the xml tag is not set. // temporary (hacked) fix for testing purposes. UPDATE: actually, - // simdata doesn't zero m_Altitude. it saved the old default value + // csplib doesn't zero m_Altitude. it saved the old default value // in the .dar file, and doesn't realize that the default has changed. virtual void postCreate() { if (m_Attitude == Quat::ZERO) m_Attitude = Quat::IDENTITY; } @@ -767,7 +767,7 @@ HardpointData(): m_External(true), m_Attitude(Quat::IDENTITY) { } - // XXX simdata should not zero m_Attitude when the xml tag is not set. temporary (hacked) fix for testing purposes. + // XXX csplib should not zero m_Attitude when the xml tag is not set. temporary (hacked) fix for testing purposes. virtual void postCreate() { if (m_Attitude == Quat::ZERO) m_Attitude = Quat::IDENTITY; } virtual Hardpoint *createHardpoint(unsigned index) const; |
