Attempt to use Doxygen command @include{doc} to keep documentation on samples in...

diff --git a/adm/gendoc.tcl b/adm/gendoc.tcl
index 19eb10a973be8c13c1997e3158f24fb8367a138e..39c698b5786a2eae7951adcd5592e6c6fa324826 100644 (file)
--- a/adm/gendoc.tcl
+++ b/adm/gendoc.tcl
@@ -818,6 +818,11 @@ proc OCCDoc_MakeDoxyfile {docType outDir tagFileDir {doxyFileName} {generatorMod
     puts $doxyFile "OUTPUT_DIRECTORY       = $outDir/."
     puts $doxyFile "PROJECT_LOGO           = [OCCDoc_GetDoxDir]/resources/occ_logo.png"
 
+    # Doxygen command \includedoc is used to add description of samples
+    puts $doxyFile "EXAMPLE_PATH           = [OCCDoc_GetDoxDir]/../samples"
+    puts $doxyFile "EXAMPLE_PATTERNS       = *.md"
+    puts $doxyFile "EXAMPLE_RECURSIVE      = YES"
+
     set PARAM_INPUT "INPUT                 ="
     set PARAM_IMAGEPATH "IMAGE_PATH        = [OCCDoc_GetDoxDir]/resources/ "
     foreach docFile $DocFilesList {

diff --git a/dox/samples/samples.md b/dox/samples/samples.md
index f6d2e53a57438ac9e8e9407f422d121c003dd70c..0c16e518d1dc62c41ea7334d53c9a505be7759d1 100644 (file)
--- a/dox/samples/samples.md
+++ b/dox/samples/samples.md
@@ -1,6 +1,8 @@
 Tutorials and Samples {#samples}
 =====================
 
+@include{doc} qt/OCCTOverview/ReadMe.md 
+
 Tutorial: Modelling a Bottle
 ----------------------------
 The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object. 

diff --git a/samples/qt/OCCTOverview/ReadMe.md b/samples/qt/OCCTOverview/ReadMe.md
index 99fae6050bf7b537eaa3d7567d265bce6e73fefb..63f571e6828396f3a5c6db242fd8e31f21d8101e 100644 (file)
--- a/samples/qt/OCCTOverview/ReadMe.md
+++ b/samples/qt/OCCTOverview/ReadMe.md
@@ -1,8 +1,6 @@
-Qt OCCT Overview samples {#samples_qt_overview}
-==========
+# Qt OCCT Overview samples {#samples_qt_overview}
 
-1. Contents
------------------------
+@subsection Contents
 
 The directory <i> samples/qt/OCCTOverview </i> contains the folders and files of the Qt OCCT Overview application: