Blame examples/autolink.cpp

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