home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / doxg1211.zip / doxygen.zip / examples / jdstyle.cpp < prev    next >
C/C++ Source or Header  |  2001-06-04  |  1KB  |  67 lines
  1. /**
  2.  *  A test class. A more elaborate class description.
  3.  */
  4.  
  5. class Test
  6. {
  7.   public:
  8.  
  9.     /** 
  10.      * An enum.
  11.      * More detailed enum description.
  12.      */
  13.  
  14.     enum TEnum { 
  15.           TVal1, /**< enum value TVal1. */  
  16.           TVal2, /**< enum value TVal2. */  
  17.           TVal3  /**< enum value TVal3. */  
  18.          } 
  19.        *enumPtr, /**< enum pointer. Details. */
  20.        enumVar;  /**< enum variable. Details. */
  21.        
  22.       /**
  23.        * A constructor.
  24.        * A more elaborate description of the constructor.
  25.        */
  26.       Test();
  27.  
  28.       /**
  29.        * A destructor.
  30.        * A more elaborate description of the destructor.
  31.        */
  32.      ~Test();
  33.     
  34.       /**
  35.        * a normal member taking two arguments and returning an integer value.
  36.        * @param a an integer argument.
  37.        * @param s a constant character pointer.
  38.        * @see Test()
  39.        * @see ~Test()
  40.        * @see testMeToo()
  41.        * @see publicVar()
  42.        * @return The test results
  43.        */
  44.        int testMe(int a,const char *s);
  45.        
  46.       /**
  47.        * A pure virtual member.
  48.        * @see testMe()
  49.        * @param c1 the first argument.
  50.        * @param c2 the second argument.
  51.        */
  52.        virtual void testMeToo(char c1,char c2) = 0;
  53.    
  54.       /** 
  55.        * a public variable.
  56.        * Details.
  57.        */
  58.        int publicVar;
  59.        
  60.       /**
  61.        * a function variable.
  62.        * Details.
  63.        */
  64.        int (*handler)(int a,int b);
  65. };
  66.  
  67.