h-file.template.doc

h_file - include file (.h) for C language

SYNOPSIS

       <mod>/include/<name>.h

       <mod>/ws/include/<name>.h
	    /lcu/include/<name>.h

 

DESCRIPTION

An include file written in C language shall be written using the convention established in the "VLT-PRO-ESO-10000-0228, 1.0 10/03/93 VLT Software Programming Standards".

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

   #ifndef <NAME>_H	     <<<< the name of the file in UPPERCASE
   #define <NAME>_H	     <<<< same as above
   /**********.. .  .
   * E.S.O. - VLT project
   *
   * "@(#) ...."	    <<<< the identificator DO NOT MODIFY IT
   *
   * who       when	   what
   * --------  ----------  -------------------- 
   * NNNNNNNN  yyyy-mm-dd  created
   */|------------------| <<<<in the template these two fields are changed
			    according to the current value of username and date.

   /**
    * @file
    * Brief description of the purpose of this .h file.
    * A more elaborated file description.
    */   
   
   
   /**
    * ........
    */
   .................... 	   /* ........ */
   .................... 	   /* ........ */
   .................... 	   /* ........ */
   
   /**
    * ........
    */
   .................... 	   /* ........ */
   .................... 	   /* ........ */
   .................... 	   /* ........ */
   
   
   #endif /*!<NAME>_H*/ 	 <<<< the name of the file in UPPERCASE