c++-h-file.template.doc

c++-h-file - Template for c++ .h include files

DESCRIPTION

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

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

 /************************************************************************
 *
 *----------------------------------------------------------------------
 */

 #ifndef __cplusplus
 #error This is a C++ include file and cannot be used from plain C
 #endif 

 //All the documentation of the class (class, method,..) is put in this .h file

 // add_include_files


 /**
  * one_line_description_of_class.
  * 
  * longer_description_of_class_meant_for_users._Developer_details_should_
  * be_put_in_the_.cpp_implementation
  *  
  */
 class ClassName { 
    public:
        /** Describe_ctor. */
        ClassName();
        /** Describe_dtor. */
        virtual ~ClassName();

        /** Describe_accessor.
         * @return Describe_return_value. */
        int getSomeMember() const { return m_someMember; }
        /** Describe_mutator.
         * @param someMember describe_input_param. */
        void setSomeMember(int someMember) { m_someMember = someMember; }

    protected:
        /**
         * Description_of_function.
         * @param someParam describe_parameter.
         * @return describe_return_value.
         */
        virtual int someFunction(int someParam);

    private:
       int m_someMember;   // purpose_and_units.
 }; 


 #endif /*!_H*/