Include missing files in Doxygen's HTML output.

Made sure that missing header files are processed when generating the HTML documentation with Doxygen. This includes type definitions, constants, global variables and functions in all DCMTK modules. This closes DCMTK Bug #532.
prodrigmd · Sep 21, 2018 · 814cfb0 · 814cfb0
1 parent 11df4c8
commit 814cfb0
Show file tree

Hide file tree

Showing 18 changed files with 98 additions and 18 deletions.
diff --git a/dcmfg/include/dcmtk/dcmfg/fgtypes.h b/dcmfg/include/dcmtk/dcmfg/fgtypes.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2015-2017, Open Connections GmbH
+ *  Copyright (C) 2015-2018, Open Connections GmbH
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -44,6 +44,13 @@ extern DCMTK_DCMFG_EXPORT OFLogger DCM_dcmfgLogger;
 #define DCMFG_FATAL(msg) OFLOG_FATAL(DCM_dcmfgLogger, msg)
 
 
+// include this file in doxygen documentation
+
+/** @file fgtypes.h
+ *  @brief type definitions, constants and helper functions for the dcmfg module
+ */
+
+
 /*-----------------------*
  *  constant definitions  *
  *-----------------------*/

diff --git a/dcmimage/include/dcmtk/dcmimage/diqttype.h b/dcmimage/include/dcmtk/dcmimage/diqttype.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2002-2010, OFFIS e.V.
+ *  Copyright (C) 2002-2018, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -15,7 +15,7 @@
  *
  *  Author:  Marco Eichelberg
  *
- *  Purpose: typdefs and constants for the color quantization classes
+ *  Purpose: typedefs and constants for the color quantization classes
  *
  */
 
@@ -42,6 +42,13 @@ typedef unsigned char DcmQuantComponent;
 #define DcmQuantMaxColors 65536
 
 
+// include this file in doxygen documentation
+
+/** @file diqttype.h
+ *  @brief type definitions and constants for the color quantization classes
+ */
+
+
 /** defines the algorithm used for determining the
  *  largest dimension in the Median Cut algorithm
  */

diff --git a/dcmimgle/include/dcmtk/dcmimgle/diutils.h b/dcmimgle/include/dcmtk/dcmimgle/diutils.h
@@ -45,7 +45,7 @@ extern DCMTK_DCMIMGLE_EXPORT OFLogger DCM_dcmimgleLogger;
 // include this file in doxygen documentation
 
 /** @file diutils.h
- *  @brief utilities for the dcmimgle/dcmimage module
+ *  @brief type definitions, constants and helper functions for the dcmimgle/dcmimage module
  */
 
 

diff --git a/dcmiod/include/dcmtk/dcmiod/cielabutil.h b/dcmiod/include/dcmtk/dcmiod/cielabutil.h
@@ -55,7 +55,7 @@ class DCMTK_DCMIOD_EXPORT IODCIELabUtil
    *  @param  B Output sRGB "R" component (blue) with 0 <= B <= 1
    *  @param  LDicom Input DICOM CIELab luminance component with 0 <= L <= 65535
    *  @param  aDicom Input DICOM CIELab "a" component (red<->green) with 0 <= a <= 65535
-   *  @param  bDicom Input DIOCM CIELab "b" component (blue<->yellow) with 0 <= a <= 65535
+   *  @param  bDicom Input DICOM CIELab "b" component (blue<->yellow) with 0 <= a <= 65535
    */
   static void dicomLab2RGB(double& R, double& G, double& B, double LDicom, double aDicom, double bDicom);
 

diff --git a/dcmjpeg/include/dcmtk/dcmjpeg/djutils.h b/dcmjpeg/include/dcmtk/dcmjpeg/djutils.h
@@ -44,7 +44,7 @@ extern DCMTK_DCMJPEG_EXPORT OFLogger DCM_dcmjpegLogger;
 // include this file in doxygen documentation
 
 /** @file djutils.h
- *  @brief enumerations, error constants and helper functions for the dcmjpeg module
+ *  @brief type definitions and constants for the dcmjpeg module
  */
 
 

diff --git a/dcmjpls/include/dcmtk/dcmjpls/djlsutil.h b/dcmjpls/include/dcmtk/dcmjpls/djlsutil.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 1997-2014, OFFIS e.V.
+ *  Copyright (C) 1997-2018, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -46,7 +46,7 @@ extern DCMTK_DCMJPLS_EXPORT OFLogger DCM_dcmjplsLogger;
 // include this file in doxygen documentation
 
 /** @file djlsutil.h
- *  @brief enumerations, error constants and helper functions for the dcmjpls module
+ *  @brief type definitions and constants for the dcmjpls module
  */
 
 

diff --git a/dcmnet/include/dcmtk/dcmnet/dcmlayer.h b/dcmnet/include/dcmtk/dcmnet/dcmlayer.h
@@ -35,6 +35,10 @@
 #include "dcmtk/dcmnet/dndefine.h"
 #include "dcmtk/dcmnet/dntypes.h"
 
+/** @file dcmlayer.h
+ *  @brief type definitions and classes for transport connections
+ */
+
 /** this enum represents the result of a transport layer operation
  *  which may be a transparent TCP/IP or a secure TLS operation.
  */
@@ -68,7 +72,6 @@ class DcmTransportConnection;
  *  Base class only supports transparent TCP connections, subclasses
  *  may also support secure transport layer connections.
  */
-
 class DCMTK_DCMNET_EXPORT DcmTransportLayer
 {
 public:
@@ -98,7 +101,7 @@ class DCMTK_DCMNET_EXPORT DcmTransportLayer
    *  or a secure connection is established.  If the object cannot be created
    *  (e. g. because no secure layer is available), returns NULL.
    *  @param openSocket TCP/IP socket to be used for the transport connection.
-   *    the connection must already be establised on socket level. If a non-null
+   *    the connection must already be established on socket level. If a non-null
    *    pointer is returned, the new connection object takes over control of the socket.
    *  @param useSecureLayer if true, a secure layer is used. If false, a
    *    transparent layer is used.

diff --git a/dcmnet/include/dcmtk/dcmnet/dcmtrans.h b/dcmnet/include/dcmtk/dcmnet/dcmtrans.h
@@ -33,6 +33,12 @@
 #define INCLUDE_UNISTD
 #include "dcmtk/ofstd/ofstdinc.h"
 
+// include this file in doxygen documentation
+
+/** @file dcmtrans.h
+ *  @brief global variables and classes for transport connections
+ */
+
 /** Global timeout in seconds for sending data on a socket to a remote host.
  *  The default value is 60, which is useful in cases where the sender (e.g.
  *  storescu) looses the connection to the receiver because the network cable

diff --git a/dcmnet/include/dcmtk/dcmnet/dcuserid.h b/dcmnet/include/dcmtk/dcmnet/dcuserid.h
@@ -27,6 +27,12 @@
 #include "dcmtk/ofstd/ofcond.h"
 #include "dcmtk/dcmnet/dndefine.h"
 
+// include this file in doxygen documentation
+
+/** @file dcuserid.h
+ *  @brief type definitions, constants and classes for User Identity Negotiation
+ */
+
 /// User Identity Negotiation request always identifies with 0x58
 #define DUL_TYPENEGOTIATIONOFUSERIDENTITY_REQ (unsigned char)0x58
 /// User Identity Negotiation acknowledge identifies with 0x59

diff --git a/dcmnet/include/dcmtk/dcmnet/dimse.h b/dcmnet/include/dcmtk/dcmnet/dimse.h
@@ -95,6 +95,12 @@
 
 class DcmOutputFileStream;
 
+// include this file in doxygen documentation
+
+/** @file dimse.h
+ *  @brief type definitions, constants, global variables and functions for the dcmnet/dimse module
+ */
+
 /** Global flag to enable/disable workaround code for some buggy Store SCUs
  * in DIMSE_storeProvider().  If enabled, an illegal space-padding in the
  * Affected SOP Instance UID field of the C-STORE-RQ message is retained

diff --git a/dcmnet/include/dcmtk/dcmnet/dul.h b/dcmnet/include/dcmtk/dcmnet/dul.h
@@ -77,6 +77,12 @@ class DcmTransportConnection;
 class DcmTransportLayer;
 class LST_HEAD;
 
+// include this file in doxygen documentation
+
+/** @file dul.h
+ *  @brief type definitions, constants, global variables and functions for the dcmnet/dul module
+ */
+
 /** Global flag to enable/disable reverse DNS lookup when accepting associations.
  *  If disabled, the numerical IP address instead of the symbolic hostname is
  *  stored in the callingPresentationAddress field of the association parameters

diff --git a/dcmqrdb/include/dcmtk/dcmqrdb/dcmqridx.h b/dcmqrdb/include/dcmtk/dcmqrdb/dcmqridx.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 1993-2017, OFFIS e.V.
+ *  Copyright (C) 1993-2018, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -40,6 +40,12 @@ BEGIN_EXTERN_C
 #endif
 END_EXTERN_C
 
+// include this file in doxygen documentation
+
+/** @file dcmqridx.h
+ *  @brief type definitions and constants for the database index file
+ */
+
 /** types of query keys
  */
 enum DB_KEY_TYPE

diff --git a/dcmseg/include/dcmtk/dcmseg/segtypes.h b/dcmseg/include/dcmtk/dcmseg/segtypes.h
@@ -41,6 +41,12 @@ extern DCMTK_DCMSEG_EXPORT OFLogger DCM_dcmsegLogger;
 #define DCMSEG_ERROR(msg) OFLOG_ERROR(DCM_dcmsegLogger, msg)
 #define DCMSEG_FATAL(msg) OFLOG_FATAL(DCM_dcmsegLogger, msg)
 
+// include this file in doxygen documentation
+
+/** @file segtypes.h
+ *  @brief type definitions, constants and helper classes for the dcmseg module
+ */
+
 /*-----------------------*
  *  constant definitions  *
  *-----------------------*/

diff --git a/dcmsign/include/dcmtk/dcmsign/sitypes.h b/dcmsign/include/dcmtk/dcmsign/sitypes.h
@@ -57,6 +57,13 @@ extern DCMTK_DCMSIGN_EXPORT OFLogger DCM_dcmsignLogger;
 #define SI_DEFTERMS_SHA512    "SHA512"
 
 
+// include this file in doxygen documentation
+
+/** @file sitypes.h
+ *  @brief type definitions and constants for the dcmsign module
+ */
+
+
 /** type of key for public key cryptosystem
  *  @remark this enum is only available if DCMTK is compiled with
  *  OpenSSL support enabled.
@@ -71,7 +78,7 @@ enum E_KeyType
 
   /// DH key
   EKT_DH,
-  
+
   /// no key present
   EKT_none
 };
@@ -85,10 +92,10 @@ enum E_MACType
 {
   /// SHA-1
   EMT_SHA1,
-  
+
   /// RIPEMD160
   EMT_RIPEMD160,
-  
+
   /// MD5
   EMT_MD5,
 
@@ -105,7 +112,7 @@ enum E_MACType
 /*
  * specific error conditions for module dcmsign
  */
- 
+
 /// object initialization failed
 /// @remark this constant is only available if DCMTK is compiled with
 /// OpenSSL support enabled.

diff --git a/dcmtls/include/dcmtk/dcmtls/tlsciphr.h b/dcmtls/include/dcmtk/dcmtls/tlsciphr.h
@@ -33,6 +33,12 @@
 #include "dcmtk/dcmtls/tlsdefin.h"    /* for DCMTK_DCMTLS_EXPORT */
 #include "dcmtk/dcmnet/dcmlayer.h"    /* for DcmTransportLayerStatus */
 
+// include this file in doxygen documentation
+
+/** @file tlsciphr.h
+ *  @brief type definitions and classes for TLS ciphersuites
+ */
+
 /** This enum describes DICOM TLS Security Profiles, which are the basis
  *  for the selection of supported ciphersuites when using DICOM over TLS.
  *  @remark This enum is only available if DCMTK is compiled with

diff --git a/dcmtls/include/dcmtk/dcmtls/tlslayer.h b/dcmtls/include/dcmtk/dcmtls/tlslayer.h
@@ -49,6 +49,13 @@ extern DCMTK_DCMTLS_EXPORT OFLogger DCM_dcmtlsLogger;
 #define DCMTLS_ERROR(msg) OFLOG_ERROR(DCM_dcmtlsLogger, msg)
 #define DCMTLS_FATAL(msg) OFLOG_FATAL(DCM_dcmtlsLogger, msg)
 
+// include this file in doxygen documentation
+
+/** @file tlslayer.h
+ *  @brief type definitions and classes for TLS transport connections
+ */
+
+
 /** this enum describes how to handle X.509 certificates on a TLS based
  *  secure transport connection. They can be ignored, validated if present
  *  or validated and demanded.

diff --git a/dcmtract/include/dcmtk/dcmtract/trctypes.h b/dcmtract/include/dcmtk/dcmtract/trctypes.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2016, Open Connections GmbH
+ *  Copyright (C) 2016-2018, Open Connections GmbH
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -41,6 +41,13 @@ extern DCMTK_DCMTRACT_EXPORT OFLogger DCM_dcmtractLogger;
 #define DCMTRACT_FATAL(msg) OFLOG_FATAL(DCM_dcmtractLogger, msg)
 
 
+// include this file in doxygen documentation
+
+/** @file trctypes.h
+ *  @brief type definitions, constants and classes for the dcmtract module
+ */
+
+
 /*
  * Definition of error codes
  */

diff --git a/dcmwlm/include/dcmtk/dcmwlm/wltypdef.h b/dcmwlm/include/dcmtk/dcmwlm/wltypdef.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 1996-2017, OFFIS e.V.
+ *  Copyright (C) 1996-2018, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -30,7 +30,7 @@
 // include this file in doxygen documentation
 
 /** @file wltypdef.h
- *  @brief type definitions and macros for the dcmwlm module
+ *  @brief type definitions and constants for the dcmwlm module
  */