c++-class-file.template.doc

c++-class - template for c++ class documentation header include files

DESCRIPTION

An empty template is provided by getTemplate(7) in the "code" menu. Complete the template according to the following example

 /*******************************************************************************
 * E.S.O. - VLT project
 *
 * "@(#) $I>-<d$"
 *
 * who       when        what
 * --------  ----------  ----------------------------------------------
 * NNNNNNNN  yyyy-mm-dd  created 
 */


  #ifndef __vxworks   >>> predefined Macros Candidates: 
        		  __vxworks #vxworks in general
        		  _WRS_KERNEL #vxWorks kernel
        		  __RTP__ # vxWorks application process (currently not used in VLT and can be replaced by 'defined(__vxworks) && !defined(_WRS_KERNEL)'
  #define _POSIX_C_SOURCE 1    <<<< if you delete this line you SHALL comment
        			    why POSIX does not apply for this file
        			    The purpose of the Macro is, to intentionally break the build if non agreed feature sets are used.
        			    For Linux you might need to remove the settings in the case that intentionally non-Posix functions will be called by the sourcecode.
        			    For VxWorks Kernel you might want to keep #define _POSIX... if you are sure that this sourcecode should not use any VxWorks specific functions
        			    For VxWorks Application processes (currently not used by VLT) you can independently decide between allowing VxWorks extensions over Posix only
  #endif
  #include "vltPort.h"

 ATTRIBUTE_UNUSED static const char *rcsId="@(#) $I>-<d$"; 

 // See the class name .h file for a description of this code 

 // add_include_files
 #include "CppTemplate.h"


 ClassName::ClassName() {
    // implement
 }

 ClassName::~ClassName() {
    // implement
 }

 // Describe_implementation_details_for_developers
 int ClassName::someFunction(int someParam) {
    // implement
    return 0;
 }


 /*___oOo___*/