Mercurial > hg > orthanc
changeset 5399:b7e60d081b81
fix comments in the Orthanc plugin SDK
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 14 Oct 2023 17:03:29 +0200 |
parents | 08b5516c6e5e |
children | bd3bae1525dd |
files | OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h |
diffstat | 1 files changed, 51 insertions(+), 31 deletions(-) [+] |
line wrap: on
line diff
--- a/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h Wed Oct 11 15:26:45 2023 +0200 +++ b/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h Sat Oct 14 17:03:29 2023 +0200 @@ -846,7 +846,7 @@ **/ typedef enum { - OrthancPluginDicomToJsonFlags_None = 0, + OrthancPluginDicomToJsonFlags_None = 0, /*!< Default formatting */ OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /*!< Include the binary tags */ OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /*!< Include the private tags */ OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /*!< Include the tags unknown by the dictionary */ @@ -861,13 +861,13 @@ /** - * Flags to the creation of a DICOM file. + * Flags for the creation of a DICOM file. * @ingroup Toolbox * @see OrthancPluginCreateDicom() **/ typedef enum { - OrthancPluginCreateDicomFlags_None = 0, + OrthancPluginCreateDicomFlags_None = 0, /*!< Default mode */ OrthancPluginCreateDicomFlags_DecodeDataUriScheme = (1 << 0), /*!< Decode fields encoded using data URI scheme */ OrthancPluginCreateDicomFlags_GenerateIdentifiers = (1 << 1), /*!< Automatically generate DICOM identifiers */ @@ -984,32 +984,46 @@ **/ typedef enum { + /** + * Success: The DICOM instance is properly stored in the SCP + **/ OrthancPluginStorageCommitmentFailureReason_Success = 0, - /*!< Success: The DICOM instance is properly stored in the SCP */ - + + /** + * 0110H: A general failure in processing the operation was encountered + **/ OrthancPluginStorageCommitmentFailureReason_ProcessingFailure = 1, - /*!< 0110H: A general failure in processing the operation was encountered */ - + + /** + * 0112H: One or more of the elements in the Referenced SOP + * Instance Sequence was not available + **/ OrthancPluginStorageCommitmentFailureReason_NoSuchObjectInstance = 2, - /*!< 0112H: One or more of the elements in the Referenced SOP - Instance Sequence was not available */ - + + /** + * 0213H: The SCP does not currently have enough resources to + * store the requested SOP Instance(s) + **/ OrthancPluginStorageCommitmentFailureReason_ResourceLimitation = 3, - /*!< 0213H: The SCP does not currently have enough resources to - store the requested SOP Instance(s) */ - + + /** + * 0122H: Storage Commitment has been requested for a SOP Instance + * with a SOP Class that is not supported by the SCP + **/ OrthancPluginStorageCommitmentFailureReason_ReferencedSOPClassNotSupported = 4, - /*!< 0122H: Storage Commitment has been requested for a SOP - Instance with a SOP Class that is not supported by the SCP */ - + + /** + * 0119H: The SOP Class of an element in the Referenced SOP + * Instance Sequence did not correspond to the SOP class + * registered for this SOP Instance at the SCP + **/ OrthancPluginStorageCommitmentFailureReason_ClassInstanceConflict = 5, - /*!< 0119H: The SOP Class of an element in the Referenced SOP - Instance Sequence did not correspond to the SOP class registered - for this SOP Instance at the SCP */ - + + /** + * 0131H: The Transaction UID of the Storage Commitment Request is + * already in use + **/ OrthancPluginStorageCommitmentFailureReason_DuplicateTransactionUID = 6 - /*!< 0131H: The Transaction UID of the Storage Commitment Request - is already in use */ } OrthancPluginStorageCommitmentFailureReason; @@ -1032,17 +1046,23 @@ **/ typedef enum { + /** + * Load the whole DICOM file, including pixel data + **/ OrthancPluginLoadDicomInstanceMode_WholeDicom = 1, - /*!< Load the whole DICOM file, including pixel data */ - + + /** + * Load the whole DICOM file until pixel data, which speeds up the + * loading + **/ OrthancPluginLoadDicomInstanceMode_UntilPixelData = 2, - /*!< Load the whole DICOM file until pixel data, which will speed - up the loading */ - + + /** + * Load the whole DICOM file until pixel data, and replace pixel + * data by an empty tag whose VR (value representation) is the + * same as those of the original DICOM file + **/ OrthancPluginLoadDicomInstanceMode_EmptyPixelData = 3, - /*!< Load the whole DICOM file until pixel data, and replace pixel - data by an empty tag whose VR (value representation) is the same - as those of the original DICOM file */ _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff } OrthancPluginLoadDicomInstanceMode; @@ -9223,7 +9243,7 @@ } _OrthancPluginRegisterDatabaseBackendV4; /** - * Register a custom database back-end. + * @brief Register a custom database back-end. * * This function was added in Orthanc SDK 1.12.0. It uses Google * Protocol Buffers for the communications between the Orthanc core