Selaa lähdekoodia

ENH: when building user documentation *_p.h and *Private.* files are not processed; and local classes' documentation is not generated

Arnaud GELAS 15 vuotta sitten
vanhempi
commit
693dc8d2be
2 muutettua tiedostoa jossa 9 lisäystä ja 5 poistoa
  1. 4 2
      Documentation/CMakeLists.txt
  2. 5 3
      Documentation/Doxyfile.txt.in

+ 4 - 2
Documentation/CMakeLists.txt

@@ -4,24 +4,26 @@ IF( DOXYGEN_FOUND )
   IF( DOXYGEN_DOT_FOUND )
   
     SET( CTK_USER_DOCUMENTATION "NO" )
+    SET( CTK_ADDITIONAL_EXCLUDE_PATTERN "*_p.h\  *Private.*" )
 
     CONFIGURE_FILE( Doxyfile.txt.in
       ${CTK_BINARY_DIR}/Documentation/UserDoxyfile.txt
     )
 
     ADD_CUSTOM_TARGET( doc 
-      ${DOXYGEN_EXECUTABLE} ${CTK_BINARY_DIR}/Documentation/Doxyfile.txt 
+      ${DOXYGEN_EXECUTABLE} ${CTK_BINARY_DIR}/Documentation/UserDoxyfile.txt 
       DEPENDS ${CTK_BINARY_DIR}/Documentation/UserDoxyfile.txt
     ) 
 
     SET( CTK_USER_DOCUMENTATION "YES" )
+    SET( CTK_ADDITIONAL_EXCLUDE_PATTERN "" )
 
     CONFIGURE_FILE( Doxyfile.txt.in
       ${CTK_BINARY_DIR}/Documentation/DevDoxyfile.txt
     )
 
     ADD_CUSTOM_TARGET( doc-dev 
-      ${DOXYGEN_EXECUTABLE} ${CTK_BINARY_DIR}/Documentation/Doxyfile.txt 
+      ${DOXYGEN_EXECUTABLE} ${CTK_BINARY_DIR}/Documentation/DevDoxyfile.txt 
       DEPENDS ${CTK_BINARY_DIR}/Documentation/DevDoxyfile.txt
     ) 
   ELSE( DOXYGEN_DOT_FOUND )

+ 5 - 3
Documentation/Doxyfile.txt.in

@@ -323,7 +323,7 @@ EXTRACT_STATIC         = YES
 # defined locally in source files will be included in the documentation.
 # If set to NO only classes defined in header files are included.
 
-EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_CLASSES  = @CTK_USER_DOCUMENTATION@
 
 # This flag is only useful for Objective-C code. When set to YES local
 # methods, which are defined in the implementation section but not in
@@ -659,7 +659,8 @@ RECURSIVE              = YES
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = @CTK_BINARY_DIR@
+EXCLUDE                = @CTK_BINARY_DIR@ \
+                         @CTK_SOURCE_DIR@/CMake
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -675,7 +676,8 @@ EXCLUDE_SYMLINKS       = NO
 
 EXCLUDE_PATTERNS       = moc_*.cxx \
                          ui_*.h \
-                         */.git/*
+                         */.git/* \
+                         @CTK_ADDITIONAL_EXCLUDE_PATTERN@
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the