doc/doxygen/Doxyfile
changeset 561 f9be4262c68d
parent 529 c171e11707c5
child 753 072787c24bec
equal deleted inserted replaced
560:0bb927393dd0 561:f9be4262c68d
   285 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
   285 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
   286 # documentation are documented, even if no documentation was available. 
   286 # documentation are documented, even if no documentation was available. 
   287 # Private class members and static file members will be hidden unless 
   287 # Private class members and static file members will be hidden unless 
   288 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
   288 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
   289 
   289 
   290 EXTRACT_ALL            = YES
   290 EXTRACT_ALL            = NO
   291 
   291 
   292 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
   292 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
   293 # will be included in the documentation.
   293 # will be included in the documentation.
   294 
   294 
   295 EXTRACT_PRIVATE        = YES
   295 EXTRACT_PRIVATE        = NO
   296 
   296 
   297 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
   297 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
   298 # will be included in the documentation.
   298 # will be included in the documentation.
   299 
   299 
   300 EXTRACT_STATIC         = YES
   300 EXTRACT_STATIC         = NO
   301 
   301 
   302 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
   302 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
   303 # defined locally in source files will be included in the documentation. 
   303 # defined locally in source files will be included in the documentation. 
   304 # If set to NO only classes defined in header files are included.
   304 # If set to NO only classes defined in header files are included.
   305 
   305 
   306 EXTRACT_LOCAL_CLASSES  = YES
   306 EXTRACT_LOCAL_CLASSES  = NO
   307 
   307 
   308 # This flag is only useful for Objective-C code. When set to YES local 
   308 # This flag is only useful for Objective-C code. When set to YES local 
   309 # methods, which are defined in the implementation section but not in 
   309 # methods, which are defined in the implementation section but not in 
   310 # the interface are included in the documentation. 
   310 # the interface are included in the documentation. 
   311 # If set to NO (the default) only methods in the interface are included.
   311 # If set to NO (the default) only methods in the interface are included.
   324 # undocumented members of documented classes, files or namespaces. 
   324 # undocumented members of documented classes, files or namespaces. 
   325 # If set to NO (the default) these members will be included in the 
   325 # If set to NO (the default) these members will be included in the 
   326 # various overviews, but no documentation section is generated. 
   326 # various overviews, but no documentation section is generated. 
   327 # This option has no effect if EXTRACT_ALL is enabled.
   327 # This option has no effect if EXTRACT_ALL is enabled.
   328 
   328 
   329 HIDE_UNDOC_MEMBERS     = NO
   329 HIDE_UNDOC_MEMBERS     = YES
   330 
   330 
   331 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
   331 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
   332 # undocumented classes that are normally visible in the class hierarchy. 
   332 # undocumented classes that are normally visible in the class hierarchy. 
   333 # If set to NO (the default) these classes will be included in the various 
   333 # If set to NO (the default) these classes will be included in the various 
   334 # overviews. This option has no effect if EXTRACT_ALL is enabled.
   334 # overviews. This option has no effect if EXTRACT_ALL is enabled.
   335 
   335 
   336 HIDE_UNDOC_CLASSES     = NO
   336 HIDE_UNDOC_CLASSES     = YES
   337 
   337 
   338 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
   338 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
   339 # friend (class|struct|union) declarations. 
   339 # friend (class|struct|union) declarations. 
   340 # If set to NO (the default) these declarations will be included in the 
   340 # If set to NO (the default) these declarations will be included in the 
   341 # documentation.
   341 # documentation.
   342 
   342 
   343 HIDE_FRIEND_COMPOUNDS  = NO
   343 HIDE_FRIEND_COMPOUNDS  = YES
   344 
   344 
   345 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
   345 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
   346 # documentation blocks found inside the body of a function. 
   346 # documentation blocks found inside the body of a function. 
   347 # If set to NO (the default) these blocks will be appended to the 
   347 # If set to NO (the default) these blocks will be appended to the 
   348 # function's detailed documentation block.
   348 # function's detailed documentation block.
   452 
   452 
   453 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
   453 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
   454 # at the bottom of the documentation of classes and structs. If set to YES the 
   454 # at the bottom of the documentation of classes and structs. If set to YES the 
   455 # list will mention the files that were used to generate the documentation.
   455 # list will mention the files that were used to generate the documentation.
   456 
   456 
   457 SHOW_USED_FILES        = YES
   457 SHOW_USED_FILES        = NO
   458 
   458 
   459 # If the sources in your project are distributed over multiple directories 
   459 # If the sources in your project are distributed over multiple directories 
   460 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
   460 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
   461 # in the documentation. The default is NO.
   461 # in the documentation. The default is NO.
   462 
   462 
   463 SHOW_DIRECTORIES       = YES
   463 SHOW_DIRECTORIES       = NO
   464 
   464 
   465 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
   465 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
   466 # This will remove the Files entry from the Quick Index and from the 
   466 # This will remove the Files entry from the Quick Index and from the 
   467 # Folder Tree View (if specified). The default is YES.
   467 # Folder Tree View (if specified). The default is YES.
   468 
   468 
   542 # The INPUT tag can be used to specify the files and/or directories that contain 
   542 # The INPUT tag can be used to specify the files and/or directories that contain 
   543 # documented source files. You may enter file names like "myfile.cpp" or 
   543 # documented source files. You may enter file names like "myfile.cpp" or 
   544 # directories like "/usr/src/myproject". Separate the files or directories 
   544 # directories like "/usr/src/myproject". Separate the files or directories 
   545 # with spaces.
   545 # with spaces.
   546 
   546 
   547 INPUT                  = ../../include ../../src ../../drivers
   547 INPUT                  = \
   548 
   548 ../../include/unix/canfestival.h \
       
   549 ../../include/can.h \
       
   550 ../../include/can_driver.h \
       
   551 ../../include/data.h \
       
   552 ../../include/emcy.h \
       
   553 ../../include/nmtMaster.h \
       
   554 ../../include/nmtSlave.h \
       
   555 ../../include/pdo.h \
       
   556 ../../include/sdo.h \
       
   557 ../../include/timers_driver.h \
       
   558 ../../include/timer.h \
       
   559 ../../include/states.h \
       
   560 ../../include/objacces.h \
       
   561 ../../src/nmtMaster.c \
       
   562 ../../drivers/unix/unix.c \
       
   563 ../../drivers/win32/win32.cpp \
       
   564 ../../src/timer.c \
       
   565 ../../src/objacces.c \
       
   566 ../../src/states.c \
       
   567 ../../drivers/timers_unix/timers_unix.c \
       
   568 ../../src/sdo.c \
       
   569 ../../src/pdo.c
       
   570 
       
   571 #../../drivers/timers_win32/timers_win32.cpp \
   549 # This tag can be used to specify the character encoding of the source files 
   572 # This tag can be used to specify the character encoding of the source files 
   550 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
   573 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
   551 # also the default input encoding. Doxygen uses libiconv (or the iconv built 
   574 # also the default input encoding. Doxygen uses libiconv (or the iconv built 
   552 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
   575 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
   553 # the list of possible encodings.
   576 # the list of possible encodings.