template_cpp.h

Go to the documentation of this file.

#ifndef __[FILENAME]_H__
#define __[FILENAME]_H__

/**
 * 
 * File Name  : [File Name].h
 *
 * Description: [A very brief description of what this file contains.  It can
 *              discuss design approach, constraints, reference design docu-
 *              mentation, etc.]
 *
 */

/*
 * This file is part of TEMPLATE.
 *
 * TEMPLATE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * TEMPLATE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2009 iRex Technologies B.V.
 * All rights reserved.
 */

//-----------------------------------------------------------------------------
// Include Files
//-----------------------------------------------------------------------------


//-----------------------------------------------------------------------------
// Macro Definitions
//----------------------------------------------------------------------------- 


//-----------------------------------------------------------------------------
// Forward Declarations
//-----------------------------------------------------------------------------


//-----------------------------------------------------------------------------
// Type Declarations
//-----------------------------------------------------------------------------


//-----------------------------------------------------------------------------
// Global Constants
//-----------------------------------------------------------------------------


//=============================================================================
// Class Declarations
//=============================================================================

/**============================================================================
*
* Class Name: [Class Name 1]
*
* @brief:     [A very detailed description regarding the [Class Name1].  It 
*              provides precise information on its functionality and purpose,
*              constraints, etc..]
*
*============================================================================*/
class [Class Name 1] : public [Base Class]
{
public:
  /// Document enumerations, typedef, or struct using '///' before its
  /// declaration.  

  /**------------------------------------------------------------------------
  *
  * Name :  [Member Function]
  *
  * @brief  [Full description of the member function of what it does,
  *          how to use it, limitations, expectations, ownership issues,
  *          etc.]
  *
  * @param  [Itemize 1st parameter and provide a meaningful description]
  * @param  [Itemize 2nd parameter and provide a meaningful description]
  * .
  * .
  * .
  * @param  [Itemize nth parameter and provide a meaningful description]
  *
  * @return [Describes the return value, if any, and its meaning] 
  *
  *--------------------------------------------------------------------------*/
   

protected:
  /// Document variables, enumerations, typedef, or struct using '///' before its
  /// declaration.  

private:
  /// Document variables, enumerations, typedef, or struct using '///' before its
  /// declaration.  

};// class [Class Name 1]


#endif