Blame examples/jdstyle.cpp

Packit 1c1d7e
/**
Packit 1c1d7e
 *  A test class. A more elaborate class description.
Packit 1c1d7e
 */
Packit 1c1d7e
Packit 1c1d7e
class Javadoc_Test
Packit 1c1d7e
{
Packit 1c1d7e
  public:
Packit 1c1d7e
Packit 1c1d7e
    /** 
Packit 1c1d7e
     * An enum.
Packit 1c1d7e
     * More detailed enum description.
Packit 1c1d7e
     */
Packit 1c1d7e
Packit 1c1d7e
    enum TEnum { 
Packit 1c1d7e
          TVal1, /**< enum value TVal1. */  
Packit 1c1d7e
          TVal2, /**< enum value TVal2. */  
Packit 1c1d7e
          TVal3  /**< enum value TVal3. */  
Packit 1c1d7e
         } 
Packit 1c1d7e
       *enumPtr, /**< enum pointer. Details. */
Packit 1c1d7e
       enumVar;  /**< enum variable. Details. */
Packit 1c1d7e
       
Packit 1c1d7e
      /**
Packit 1c1d7e
       * A constructor.
Packit 1c1d7e
       * A more elaborate description of the constructor.
Packit 1c1d7e
       */
Packit 1c1d7e
      Javadoc_Test();
Packit 1c1d7e
Packit 1c1d7e
      /**
Packit 1c1d7e
       * A destructor.
Packit 1c1d7e
       * A more elaborate description of the destructor.
Packit 1c1d7e
       */
Packit 1c1d7e
     ~Javadoc_Test();
Packit 1c1d7e
    
Packit 1c1d7e
      /**
Packit 1c1d7e
       * a normal member taking two arguments and returning an integer value.
Packit 1c1d7e
       * @param a an integer argument.
Packit 1c1d7e
       * @param s a constant character pointer.
Packit 1c1d7e
       * @see Javadoc_Test()
Packit 1c1d7e
       * @see ~Javadoc_Test()
Packit 1c1d7e
       * @see testMeToo()
Packit 1c1d7e
       * @see publicVar()
Packit 1c1d7e
       * @return The test results
Packit 1c1d7e
       */
Packit 1c1d7e
       int testMe(int a,const char *s);
Packit 1c1d7e
       
Packit 1c1d7e
      /**
Packit 1c1d7e
       * A pure virtual member.
Packit 1c1d7e
       * @see testMe()
Packit 1c1d7e
       * @param c1 the first argument.
Packit 1c1d7e
       * @param c2 the second argument.
Packit 1c1d7e
       */
Packit 1c1d7e
       virtual void testMeToo(char c1,char c2) = 0;
Packit 1c1d7e
   
Packit 1c1d7e
      /** 
Packit 1c1d7e
       * a public variable.
Packit 1c1d7e
       * Details.
Packit 1c1d7e
       */
Packit 1c1d7e
       int publicVar;
Packit 1c1d7e
       
Packit 1c1d7e
      /**
Packit 1c1d7e
       * a function variable.
Packit 1c1d7e
       * Details.
Packit 1c1d7e
       */
Packit 1c1d7e
       int (*handler)(int a,int b);
Packit 1c1d7e
};
Packit 1c1d7e