Blame examples/autolink.cpp

Packit 1c1d7e
/*! \file autolink.cpp
Packit 1c1d7e
  Testing automatic link generation.
Packit 1c1d7e
  
Packit 1c1d7e
  A link to a member of the Autolink_Test class: Autolink_Test::member, 
Packit 1c1d7e
  
Packit 1c1d7e
  More specific links to the each of the overloaded members:
Packit 1c1d7e
  Autolink_Test::member(int) and Autolink_Test#member(int,int)
Packit 1c1d7e
Packit 1c1d7e
  A link to a protected member variable of Autolink_Test: Autolink_Test#var, 
Packit 1c1d7e
Packit 1c1d7e
  A link to the global enumeration type #GlobEnum.
Packit 1c1d7e
 
Packit 1c1d7e
  A link to the define #ABS(x).
Packit 1c1d7e
  
Packit 1c1d7e
  A link to the destructor of the Autolink_Test class: Autolink_Test::~Autolink_Test, 
Packit 1c1d7e
  
Packit 1c1d7e
  A link to the typedef ::B.
Packit 1c1d7e
 
Packit 1c1d7e
  A link to the enumeration type Autolink_Test::EType
Packit 1c1d7e
  
Packit 1c1d7e
  A link to some enumeration values Autolink_Test::Val1 and ::GVal2
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
/*!
Packit 1c1d7e
  Since this documentation block belongs to the class Autolink_Test no link to 
Packit 1c1d7e
  Autolink_Test is generated.
Packit 1c1d7e
Packit 1c1d7e
  Two ways to link to a constructor are: #Autolink_Test and Autolink_Test().
Packit 1c1d7e
Packit 1c1d7e
  Links to the destructor are: #~Autolink_Test and ~Autolink_Test().
Packit 1c1d7e
  
Packit 1c1d7e
  A link to a member in this class: member().
Packit 1c1d7e
Packit 1c1d7e
  More specific links to the each of the overloaded members: 
Packit 1c1d7e
  member(int) and member(int,int). 
Packit 1c1d7e
  
Packit 1c1d7e
  A link to the variable #var.
Packit 1c1d7e
Packit 1c1d7e
  A link to the global typedef ::B.
Packit 1c1d7e
Packit 1c1d7e
  A link to the global enumeration type #GlobEnum.
Packit 1c1d7e
  
Packit 1c1d7e
  A link to the define ABS(x).
Packit 1c1d7e
  
Packit 1c1d7e
  A link to a variable \link #var using another text\endlink as a link.
Packit 1c1d7e
  
Packit 1c1d7e
  A link to the enumeration type #EType.
Packit 1c1d7e
Packit 1c1d7e
  A link to some enumeration values: \link Autolink_Test::Val1 Val1 \endlink and ::GVal1.
Packit 1c1d7e
Packit 1c1d7e
  And last but not least a link to a file: autolink.cpp.
Packit 1c1d7e
  
Packit 1c1d7e
  \sa Inside a see also section any word is checked, so EType, 
Packit 1c1d7e
      Val1, GVal1, ~Autolink_Test and member will be replaced by links in HTML.
Packit 1c1d7e
*/
Packit 1c1d7e
Packit 1c1d7e
class Autolink_Test
Packit 1c1d7e
{
Packit 1c1d7e
  public:
Packit 1c1d7e
    Autolink_Test();               //!< constructor 
Packit 1c1d7e
   ~Autolink_Test();               //!< destructor 
Packit 1c1d7e
    void member(int);     /**< A member function. Details. */
Packit 1c1d7e
    void member(int,int); /**< An overloaded member function. Details */
Packit 1c1d7e
Packit 1c1d7e
    /** An enum type. More details */
Packit 1c1d7e
    enum EType { 
Packit 1c1d7e
      Val1,               /**< enum value 1 */ 
Packit 1c1d7e
      Val2                /**< enum value 2 */ 
Packit 1c1d7e
    };                
Packit 1c1d7e
Packit 1c1d7e
  protected:
Packit 1c1d7e
    int var;              /**< A member variable */
Packit 1c1d7e
};
Packit 1c1d7e
Packit 1c1d7e
/*! details. */
Packit 1c1d7e
Autolink_Test::Autolink_Test() { }
Packit 1c1d7e
Packit 1c1d7e
/*! details. */
Packit 1c1d7e
Autolink_Test::~Autolink_Test() { }
Packit 1c1d7e
Packit 1c1d7e
/*! A global variable. */
Packit 1c1d7e
int globVar;
Packit 1c1d7e
Packit 1c1d7e
/*! A global enum. */
Packit 1c1d7e
enum GlobEnum { 
Packit 1c1d7e
                GVal1,    /*!< global enum value 1 */ 
Packit 1c1d7e
                GVal2     /*!< global enum value 2 */ 
Packit 1c1d7e
              };
Packit 1c1d7e
Packit 1c1d7e
/*!
Packit 1c1d7e
 *  A macro definition.
Packit 1c1d7e
 */ 
Packit 1c1d7e
#define ABS(x) (((x)>0)?(x):-(x))
Packit 1c1d7e
Packit 1c1d7e
typedef Autolink_Test B;
Packit 1c1d7e
Packit 1c1d7e
/*! \fn typedef Autolink_Test B
Packit 1c1d7e
 *  A type definition. 
Packit 1c1d7e
 */