0025226: Reference Manual -- list of classes in package is polluted
authorabv <abv@opencascade.com>
Mon, 8 Sep 2014 14:17:50 +0000 (18:17 +0400)
committerbugmaster <bugmaster@opencascade.com>
Thu, 11 Sep 2014 08:40:06 +0000 (12:40 +0400)
Documentation generator corrected to avoid adding irrelevant classes to the package list.

adm/gendoc.tcl
adm/occaux.tcl

index 2242696..87e02d5 100644 (file)
@@ -684,7 +684,7 @@ proc OCCDoc_MakeDoxyfile {docType outDir tagFileDir {doxyFileName} {generatorMod
       foreach tk [$module:toolkits] {
         foreach pk [split [OCCDoc_GetPackagesList [OCCDoc_Locate $tk $productsPath]]] {
           if { [llength $pk] != "{}" } {
-            lappend filelist [OCCDoc_GetHeadersList "p" "pubinclude" "$pk" "$productsPath"]
+            lappend filelist [OCCDoc_GetHeadersList "p" "$pk" "$productsPath"]
           }
         }
       }
index 161fd74..f732f01 100644 (file)
@@ -537,26 +537,15 @@ proc OCCDoc_GetModulesList { {theProductsDir ""} } {
 }
 
 # Returns list of desired files in the specified location
-proc OCCDoc_GetHeadersList { theDesiredContent theFileType thePackageName {theProductsDir ""} } {
+proc OCCDoc_GetHeadersList { theDesiredContent thePackageName {theProductsDir ""} } {
+
+  # Get list of header files with path
+  set files_list [split [glob -nocomplain -type f -directory "[OCCDoc_GetIncDir $theProductsDir]" "${thePackageName}.hxx" "${thePackageName}_*.hxx"]]
 
-  # Get file type
-  set file_type_pattern "*.*"
-  if { $theFileType == "pubinclude" } {
-    set file_type_pattern "*.*"
-  } elseif { $theFileType == "privinclude" } {
-    set file_type_pattern "*.ixx"
-  }
-  
   # Get content according to desired type ('p' for path and 'f' for filenames only)
   if { $theDesiredContent == "p" } {
-
-    # Get list of files with path
-    set files_list [split [glob -nocomplain -type f -directory "[OCCDoc_GetIncDir $theProductsDir]" "$thePackageName$file_type_pattern"]]
-
     return $files_list
   } elseif { $theDesiredContent == "f" } {
-  # Get list of files without path
-    set files_list [split [glob -nocomplain -type f -directory "[OCCDoc_GetIncDir $theProductsDir]" "$thePackageName$file_type_pattern"]]
 
     # Cut paths from filenames
     foreach file $files_list {
@@ -662,7 +651,7 @@ proc OCCDoc_MakeMainPage {outDir outFile modules {theProductsDir ""} } {
     set u [OCCDoc_GetNameFromPath $pk]
     puts $fd "/**"
     puts $fd "\\page [string tolower $package_prefix$u] Package $u"
-    foreach hdr [lsort [OCCDoc_GetHeadersList "f" "pubinclude" "$pk" "$theProductsDir"]] {
+    foreach hdr [lsort [OCCDoc_GetHeadersList "f" "$pk" "$theProductsDir"]] {
       if { ! [regexp {^Handle_} $hdr] && [regexp {(.*)[.]hxx} $hdr str obj] } {
         puts $fd "\\li \\subpage $obj"
       }