From: abv Date: Fri, 30 Oct 2020 11:18:08 +0000 (+0300) Subject: Attempt to use Doxygen command @include{doc} to keep documentation on samples in... X-Git-Url: http://git.dev.opencascade.org/gitweb/?a=commitdiff_plain;h=5d4b9dd38df402601bdb18d17459e58f1aab7611;p=occt-copy.git Attempt to use Doxygen command @include{doc} to keep documentation on samples in separate files, does not work (as per Doxygen 1.8.20) -- Doxygen does not handle headings in the included file --- diff --git a/adm/gendoc.tcl b/adm/gendoc.tcl index 19eb10a973..39c698b578 100644 --- 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 f6d2e53a57..0c16e518d1 100644 --- 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 99fae6050b..63f571e682 100644 --- 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 samples/qt/OCCTOverview contains the folders and files of the Qt OCCT Overview application: