Changeset 19694

Show
Ignore:
Timestamp:
12/18/06 16:43:51 (2 years ago)
Author:
patrick
Message:

Update the comment describing the purpose of these files to use Doxygen
syntax and to contain accurate information.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/trunk/modules/vrjuggler/vrj/Draw/Direct3D/Config.h

    r19672 r19694  
    2929/* #pragma once */ 
    3030 
    31 /* 
    32  * ---------------------------------------------------------------------------- 
    33  * This file (vjConfig.h) includes header files common to most, if not all, 
    34  * files in the VR Juggler source tree.  It must be included at the top of 
    35  * every .h and .cpp file before any other headers because it includes system 
    36  * headers. 
    37  * ---------------------------------------------------------------------------- 
     31/** 
     32 * \file 
     33 * 
     34 * This file is to be used by code in the Direct3D Draw Manager for ensuring 
     35 * that platform-specific preprocessor symbols are defined correctly. In 
     36 * particular, this file handles the Windows DLL and automatic linking 
     37 * features for the Direct3D Draw Manager shared library. It must be included 
     38 * at the top of every .h and .cpp file in the Direct3D Draw Manager source 
     39 * before any other headers. 
    3840 */ 
    3941 

  • juggler/trunk/modules/vrjuggler/vrj/Draw/OGL/Config.h

    r19030 r19694  
    2929/* #pragma once */ 
    3030 
    31 /* 
    32  * ---------------------------------------------------------------------------- 
    33  * This file (vjConfig.h) includes header files common to most, if not all, 
    34  * files in the VR Juggler source tree.  It must be included at the top of 
    35  * every .h and .cpp file before any other headers because it includes system 
    36  * headers. 
    37  * ---------------------------------------------------------------------------- 
     31/** 
     32 * \file 
     33 * 
     34 * This file is to be used by code in the OpenGL Draw Manager for ensuring 
     35 * that platform-specific preprocessor symbols are defined correctly. In 
     36 * particular, this file handles the Windows DLL and automatic linking 
     37 * features for the OpenGL Draw Manager shared library. It must be included at 
     38 * the top of every .h and .cpp file in the OpenGL Draw Manager source 
     39 * before any other headers. 
    3840 */ 
    3941 

  • juggler/trunk/modules/vrjuggler/vrj/Draw/Pf/Config.h

    r19030 r19694  
    2929/* #pragma once */ 
    3030 
    31 /* 
    32  * ---------------------------------------------------------------------------- 
    33  * This file (vjConfig.h) includes header files common to most, if not all, 
    34  * files in the VR Juggler source tree.  It must be included at the top of 
    35  * every .h and .cpp file before any other headers because it includes system 
    36  * headers. 
    37  * ---------------------------------------------------------------------------- 
     31/** 
     32 * \file 
     33 * 
     34 * This file is to be used by code in the OpenGL Performer Draw Manager for 
     35 * ensuring that platform-specific preprocessor symbols are defined correctly. 
     36 * In particular, this file handles the Windows DLL and automatic linking 
     37 * features for the OpenGL Performer Draw Manager shared library. It must be 
     38 * included at the top of every .h and .cpp file in the OpenGL Performer Draw 
     39 * Manager source before any other headers. 
    3840 */ 
    3941 

  • juggler/trunk/modules/vrjuggler/vrj/vrjConfig.h

    r19030 r19694  
    2929/* #pragma once */ 
    3030 
    31 /* 
    32  * ---------------------------------------------------------------------------- 
    33  * This file (vjConfig.h) includes header files common to most, if not all, 
    34  * files in the VR Juggler source tree.  It must be included at the top of 
    35  * every .h and .cpp file before any other headers because it includes system 
    36  * headers. 
    37  * ---------------------------------------------------------------------------- 
     31/** 
     32 * \file 
     33 * 
     34 * This file is to be used by code in the base VR Juggler library for ensuring 
     35 * that platform-specific preprocessor symbols are defined correctly. In 
     36 * particular, this file handles the Windows DLL and automatic linking 
     37 * features for the base VR Juggler shared library. It must be included at the 
     38 * top of every .h and .cpp file in the source tree (other than for the Draw 
     39 * Manager implementations) before any other headers. 
     40 * 
     41 * @note The Draw Manager implementations have their own Config.h files that 
     42 *       include this file. 
    3843 */ 
    3944