initial version

1 files changed, 99 insertions, 0 deletions

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