From b208acf4a03b06889944e3d2d16d1105ac593484 Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Wed, 23 Aug 2017 09:41:10 +0200 Subject: [PATCH] moved doxy.config to here --- slsDetectorSoftware/doxy.config | 164 ++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 slsDetectorSoftware/doxy.config diff --git a/slsDetectorSoftware/doxy.config b/slsDetectorSoftware/doxy.config new file mode 100644 index 000000000..9dec99861 --- /dev/null +++ b/slsDetectorSoftware/doxy.config @@ -0,0 +1,164 @@ +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + + + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# 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 + +# 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 +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +INTERNAL_DOCS = NO + +SHOW_INCLUDE_FILES = NO + +SHOW_FILES = NO + +SHOW_NAMESPACES = NO + +COMPACT_LATEX = YES + +PAPER_TYPE = a4 + +PDF_HYPERLINKS = YES + +USE_PDFLATEX = YES + +LATEX_HIDE_INDICES = YES + +PREDEFINED = __cplusplus + +INPUT = commonFiles/communication_funcs.h \ + commonFiles/error_defs.h \ + commonFiles/sls_detector_defs.h \ + commonFiles/sls_detector_funcs.h \ + f90Interface/externPostProcessing.h \ + multiSlsDetector/multiSlsDetectorClient.h \ + multiSlsDetector/multiSlsDetectorCommand.h \ + multiSlsDetector/multiSlsDetector.h \ + slsDetector/slsDetectorActions.h \ + slsDetector/slsDetectorBase.h \ + slsDetector/slsDetectorCommand.h \ + slsDetector/slsDetector.h \ + slsDetector/slsDetectorUsers.h \ + slsDetector/slsDetectorUtils.h \ + slsDetectorAnalysis/angCalLogClass.h \ + slsDetectorAnalysis/angleConversionConstant.h \ + slsDetectorAnalysis/angularCalibration.h \ + slsDetectorAnalysis/angularConversion.h \ + slsDetectorAnalysis/AngularConversion_Standalone.h \ + slsDetectorAnalysis/angularConversionStatic.h \ + slsDetectorAnalysis/badChannelCorrections.h \ + slsDetectorAnalysis/detectorData.h \ + slsDetectorAnalysis/enCalLogClass.h \ + slsDetectorAnalysis/energyCalibration.h \ + slsDetectorAnalysis/energyConversion.h \ + slsDetectorAnalysis/fileIO.h \ + slsDetectorAnalysis/FileIO_Standalone.h \ + slsDetectorAnalysis/fileIOStatic.h \ + slsDetectorAnalysis/movingStat.h \ + slsDetectorAnalysis/postProcessingFileIO_Standalone.h \ + slsDetectorAnalysis/postProcessingFuncs.h \ + slsDetectorAnalysis/postProcessing.h \ + slsDetectorAnalysis/postProcessing_Standalone.h \ + slsDetectorAnalysis/runningStat.h \ + slsDetectorAnalysis/singlePhotonFilter.h \ + slsDetectorAnalysis/single_photon_hit.h \ + slsDetectorAnalysis/TSlsDetectorDict.h \ + slsReceiverInterface/receiverInterface.h \ + threadFiles/CondVar.h \ + threadFiles/Global.h \ + threadFiles/Multi.h \ + threadFiles/Mutex.h \ + threadFiles/Single.h \ + threadFiles/Task.h \ + threadFiles/ThreadPool.h \ + usersFunctions/angleFunction.h \ + usersFunctions/usersFunctions.h \ + ../slsReceiverSoftware/include/ansi.h \ + ../slsReceiverSoftware/include/BinaryFile.h \ + ../slsReceiverSoftware/include/BinaryFileStatic.h \ + ../slsReceiverSoftware/include/circularFifo.h \ + ../slsReceiverSoftware/include/DataProcessor.h \ + ../slsReceiverSoftware/include/DataStreamer.h \ + ../slsReceiverSoftware/include/Fifo.h \ + ../slsReceiverSoftware/include/File.h \ + ../slsReceiverSoftware/include/GeneralData.h \ + ../slsReceiverSoftware/include/genericSocket.h \ + ../slsReceiverSoftware/include/HDF5File.h \ + ../slsReceiverSoftware/include/HDF5FileStatic.h \ + ../slsReceiverSoftware/include/Listener.h \ + ../slsReceiverSoftware/include/logger.h \ + ../slsReceiverSoftware/include/MySocketTCP.h \ + ../slsReceiverSoftware/include/receiver_defs.h \ + ../slsReceiverSoftware/include/RestHelper.h \ + ../slsReceiverSoftware/include/sls_receiver_defs.h \ + ../slsReceiverSoftware/include/sls_receiver_funcs.h \ + ../slsReceiverSoftware/include/slsReceiver.h \ + ../slsReceiverSoftware/include/slsReceiverTCPIPInterface.h \ + ../slsReceiverSoftware/include/slsReceiverUsers.h \ + ../slsReceiverSoftware/include/ThreadObject.h \ + ../slsReceiverSoftware/include/UDPBaseImplementation.h \ + ../slsReceiverSoftware/include/UDPInterface.h \ + ../slsReceiverSoftware/include/UDPRESTImplementation.h \ + ../slsReceiverSoftware/include/UDPStandardImplementation.h \ + ../slsReceiverSoftware/include/utilities.h \ + ../slsReceiverSoftware/include/ZmqSocket.h + + + + +OUTPUT_DIRECTORY = slsDetectorPackageDocs +