OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-09 18:50:54 +03:00
Code Packages Releases Activity

0026537: It is not possible to generate reference documentation in new structure of OCCT

Browse Source 
the path to search required headers changed from <occt>/inc to <occt>/src/<each package>

Fix for OCCT products reference documentation
This commit is contained in:
ibs 2015-08-13 11:19:10 +03:00 committed by ski
parent 1e75b579dd
commit a9d2efda86
4 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
adm/gendoc.tcl
View File

@ -166,7 +166,7 @@ proc gendoc {args} {
if { $DOCTYPE_COMBO_FLAG != 1 } { if { $DOCTYPE_COMBO_FLAG != 1 } {
set DOC_TYPE "REFMAN" set DOC_TYPE "REFMAN"
set DOCTYPE_COMBO_FLAG 1 set DOCTYPE_COMBO_FLAG 1
if { [file exists [pwd]/src/VAS/Products.tcl] } { if { [info exists env(PRODROOT)] && [file exists $::env(PRODROOT)/src/VAS/Products.tcl] } {
set GENERATE_PRODUCTS_REFMAN "YES" set GENERATE_PRODUCTS_REFMAN "YES"
} }
} else { } else {
@ -190,13 +190,6 @@ proc gendoc {args} {
puts "" puts ""
} }
if { $GENERATE_PRODUCTS_REFMAN == "YES" } {
if { [ lsearch $args_names "m" ] == -1 } {
puts "\nError: Cannot generate Reference Manual for the whole set of OCC Products."
puts "Aborting..."
return -1
}
}
} elseif {$arg_n == "v"} { } elseif {$arg_n == "v"} {
set VERB_MODE "YES" set VERB_MODE "YES"
} elseif {$arg_n == "ug"} { } elseif {$arg_n == "ug"} {
@ -306,9 +299,8 @@ proc gendoc {args} {
puts "" puts ""
# Clean logfiles # Clean logfiles
set OUTDIR [OCCDoc_GetRootDir]/doc/ set DOXYLOG [OCCDoc_GetRootDir]/doc/doxygen_warnings_and_errors.log
set DOXYLOG $OUTDIR/doxygen_warnings_and_errors.log set PDFLOG [OCCDoc_GetRootDir]/doc/pdflatex_warnings_and_errors.log
set PDFLOG $OUTDIR/pdflatex_warnings_and_errors.log
file delete -force $PDFLOG file delete -force $PDFLOG
file delete -force $DOXYLOG file delete -force $DOXYLOG
@ -338,7 +330,7 @@ proc OCCDoc_Main {docType {docfiles {}} {modules {}} generatorMode verboseMode s
set PRODPATH "" set PRODPATH ""
if { [string compare -nocase $generateProductsRefman "YES"] == 0 } { if { [string compare -nocase $generateProductsRefman "YES"] == 0 } {
set PRODPATH [pwd] set PRODPATH "$::env(PRODROOT)"
} }
set ROOTDIR [OCCDoc_GetRootDir $PRODPATH] set ROOTDIR [OCCDoc_GetRootDir $PRODPATH]
@ -351,7 +343,7 @@ proc OCCDoc_Main {docType {docfiles {}} {modules {}} generatorMode verboseMode s
set HTMLDIR $OUTDIR/overview/html set HTMLDIR $OUTDIR/overview/html
set LATEXDIR $OUTDIR/overview/latex set LATEXDIR $OUTDIR/overview/latex
set DOXYFILE $OUTDIR/OCCT.cfg set DOXYFILE $OUTDIR/OCCT.cfg
# Create or cleanup the output folders # Create or cleanup the output folders
if { [string compare -nocase $generateProductsRefman "YES"] != 0 } { if { [string compare -nocase $generateProductsRefman "YES"] != 0 } {
if { ![file exists $OUTDIR] } { if { ![file exists $OUTDIR] } {

3
adm/occaux.tcl
View File

@ -531,6 +531,7 @@ proc OCCDoc_GetModulesList { {theProductsDir ""} } {
source "[OCCDoc_GetSourceDir $theProductsDir]/VAS/Products.tcl" source "[OCCDoc_GetSourceDir $theProductsDir]/VAS/Products.tcl"
# load a command from this file # load a command from this file
set modules [VAS:Products] set modules [VAS:Products]
set modules [lsearch -not -all -inline $modules "VAS"]
} }
return $modules return $modules
@ -540,7 +541,7 @@ proc OCCDoc_GetModulesList { {theProductsDir ""} } {
proc OCCDoc_GetHeadersList { theDesiredContent thePackageName {theProductsDir ""} } { proc OCCDoc_GetHeadersList { theDesiredContent thePackageName {theProductsDir ""} } {
# Get list of header files with path # Get list of header files with path
set files_list [split [glob -nocomplain -type f -directory "[OCCDoc_GetIncDir $theProductsDir]" "${thePackageName}.hxx" "${thePackageName}_*.hxx"]] set files_list [split [glob -nocomplain -type f -directory "[OCCDoc_GetSourceDir $theProductsDir]/$thePackageName" "${thePackageName}.hxx" "${thePackageName}_*.hxx"]]
# Get content according to desired type ('p' for path and 'f' for filenames only) # Get content according to desired type ('p' for path and 'f' for filenames only)
if { $theDesiredContent == "p" } { if { $theDesiredContent == "p" } {

1
adm/templates/env.bat.in
View File

@ -19,6 +19,7 @@ if exist "%~dp0custom.bat" (
) )
if ["%CASROOT%"] == [""] set "CASROOT=%SCRIPTROOT%" if ["%CASROOT%"] == [""] set "CASROOT=%SCRIPTROOT%"
set "PRODROOT="
set "ORIGIN_PATH=%PATH%" set "ORIGIN_PATH=%PATH%"

1
adm/templates/env.build.bat.in
View File

@ -21,6 +21,7 @@ if exist "%~dp0custom.bat" (
) )
if ["%CASROOT%"] == [""] set "CASROOT=%SCRIPTROOT%" if ["%CASROOT%"] == [""] set "CASROOT=%SCRIPTROOT%"
set "PRODROOT="
set "ORIGIN_PATH=%PATH%" set "ORIGIN_PATH=%PATH%"