00001 ////////////////////////////////////////////////////////////////////////////////////////////////// 00002 /*! \file SampleFile.cpp 00003 * \brief Example of a file for the Spacecraft Simulation Framework sourcecode. 00004 * \author $Author: cakinli $ 00005 * \version $Revision: 1.1.1.1 $ 00006 * \date $Date: 2005/04/26 17:40:55 $ 00007 *////////////////////////////////////////////////////////////////////////////////////////////////// 00008 /* \warning Are there any warnings about this file? 00009 * \todo Is there anything left to do in this file? 00010 */ 00011 ////////////////////////////////////////////////////////////////////////////////////////////////// 00012 00013 /** All of the SSF sourcecode should use Doxygen (www.doxygen.org) style commenting */ 00014 00015 /** \brief Example Function and associated documentation 00016 * Detailed description of function 00017 * @param _inputVariable variable that is used in function to compute stuff [units]. 00018 * @return whatever the example function returns [units]. 00019 */ 00020 int ExampleFunction(int _inputVariable) 00021 { 00022 return _inputVariable; 00023 } 00024 00025 // Do not change the comments below - they will be added automatically by CVS 00026 /***************************************************************************** 00027 * $Log: SampleFile.cpp,v $ 00028 * Revision 1.1.1.1 2005/04/26 17:40:55 cakinli 00029 * Adding OpenSESSAME to DSACSS distrib to capture fixed version. 00030 * 00031 * Revision 1.2 2003/03/26 16:38:58 nilspace 00032 * Updated comments to better work with Doxygen. 00033 * 00034 * Revision 1.1 2003/03/05 20:41:04 nilspace 00035 * Initial submission of example source code file. 00036 * 00037 * 00038 ******************************************************************************/
1.3.9.1