From: mkr <mkr@opencascade.com>
Date: Wed, 10 Dec 2008 09:02:54 +0000 (+0000)
Subject: A sample of how to insert links into the main doc page to files, classes, functions... 
X-Git-Tag: V2008a~8
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f00642156c9bd6d988dadd80a566064cb947c4fd;p=modules%2Fparavis.git

A sample of how to insert links into the main doc page to files, classes, functions and fields in the documentation generated by Doxygen.
---

diff --git a/src/PVGUI/PVGUI_Module.h b/src/PVGUI/PVGUI_Module.h
index 5afdb556..ba573470 100644
--- a/src/PVGUI/PVGUI_Module.h
+++ b/src/PVGUI/PVGUI_Module.h
@@ -28,6 +28,28 @@
 
   Insert the content of introduction page here.
 
+  A link to the file documentation PVGUI_Module_actions.cxx
+
+  A link to the file documentation PVGUI_Module_impl.h
+
+  A link to the class documentation PVGUI_Module
+
+  The class name as a text (not a link to its documentation) %PVGUI_Module
+
+  A link to the constructor of the class PVGUI_ViewWindow#PVGUI_ViewWindow or PVGUI_Module::PVGUI_Module()
+
+  A link to the destructor of the class PVGUI_ViewWindow#~PVGUI_ViewWindow
+
+  A link to the member function PVGUI_ViewWindow::getVisualParameters or PVGUI_ViewWindow#getVisualParameters
+
+  Arguments of a function should be specified only for the overloaded functions PVGUI_Module::initialize(CAM_Application*)
+
+  A link to some enumeration values PVGUI_Module::OpenFileId and PVGUI_Module::CreateLookmarkId
+
+  A link to a protected member variable of the class PVGUI_ViewWindow#myModel
+
+  A link to a variable \link PVGUI_ViewWindow#myModel using another text\endlink as a link
+
 */
 
 #ifndef PVGUI_Module_H