Skip to content

Commit 7ec2a25

Browse files
committed
Fixed minor issues in manpage.
Fixed minor issues in manpage, e.g. capitalization, line breaks, indentation and missing Doxygen markup.
1 parent 966e0c7 commit 7ec2a25

File tree

2 files changed

+22
-25
lines changed

2 files changed

+22
-25
lines changed

dcmdata/docs/dcm2json.man

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ bulk data URI options:
134134
write bulk data files to d (default: '.')
135135

136136
+bs --bulk-subdir
137-
create subdirectory for each SOP instance
138-
(default: no subdirectory)
137+
create subdirectory for each SOP instance
138+
(default: no subdirectory)
139139
\endverbatim
140140

141141
\subsection dcm2json_output_options output options
@@ -321,22 +321,19 @@ the following (see DICOM Part 18 Section F for details):
321321

322322
By default, binary data, i.e. DICOM element values with Value Representations
323323
(VR) of OB, OD, OF, OL, OV, OW, and UN values are written as "InlineBinary"
324-
(base64 encoding) to the JSON output.
325-
Option \e --bulk-enabled causes binary data as well as
326-
DS, FD, FL, IS, SV and UV to be replaced by "BulkDataURI" values if the
327-
element value is larger than the cut-off threshold (default: 1 kByte).
328-
The cut-off threshold can be specified with the \e --bulk-size option.
329-
The element values themselves are written as files to the directory
330-
given by the \e --bulk-dir option (default: current directory).
331-
The filename is based on a SHA-256 checksum of the element value.
332-
By default, file URIs are generated that point to the bulk directory.
333-
For production use, a URI prefix for a WADO-RS service over which the
334-
element values can be retrieved should be specified using the
335-
\e --bulk-uri-prefix option. This can be implemented by configuring
336-
a web server that has read access to \b dcm2json's bulk directory.
337-
Finally, the option \e --bulk-subdir will cause a separate
338-
subdirectory to be created (and used in the bulk data URI) for each
339-
distinct SOP instance.
324+
(base64 encoding) to the JSON output. Option \e --bulk-enabled causes binary
325+
data as well as DS, FD, FL, IS, SV and UV to be replaced by "BulkDataURI"
326+
values if the element value is larger than the cut-off threshold (default: 1
327+
kByte). The cut-off threshold can be specified with the \e --bulk-size option.
328+
The element values themselves are written as files to the directory given by
329+
the \e --bulk-dir option (default: current directory). The filename is based
330+
on a SHA-256 checksum of the element value. By default, file URIs are
331+
generated that point to the bulk directory. For production use, a URI prefix
332+
for a WADO-RS service over which the element values can be retrieved should be
333+
specified using the \e --bulk-uri-prefix option. This can be implemented by
334+
configuring a web server that has read access to \b dcm2json's bulk directory.
335+
Finally, the option \e --bulk-subdir will cause a separate subdirectory to be
336+
created (and used in the bulk data URI) for each distinct SOP instance.
340337

341338
Note that the JSON syntax for the representation of encapsulated pixel data
342339
in "InlineBinary" form is unspecified in DICOM, as is the JSON representation
@@ -379,8 +376,8 @@ parsers cannot process larger numbers.
379376
\subsection dcm2json_character_encoding Character Encoding
380377

381378
As required by the DICOM JSON encoding, \b dcm2json always creates output in
382-
Unicode UTF-8 encoding and converts DICOM datasets accordingly. If this is not
383-
possible, for example because DCMTK has been compiled without character set
379+
Unicode UTF-8 encoding and converts DICOM data sets accordingly. If this is
380+
not possible, for example because DCMTK has been compiled without character set
384381
conversion support, an error is returned.
385382

386383
\section dcm2json_logging LOGGING

dcmdata/docs/json2dcm.man

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -335,11 +335,11 @@ case is not defined in the DICOM standard yet.
335335

336336
\subsection json2dcm_trailing_commas Trailing Commas
337337

338-
Trailing commas are not permitted in JSON, but \b json2dcm will still
339-
accept such JSON datasets without warning or error message because they
340-
are handled gracefully by the underlying JSON parser. Users should, therefore,
341-
not assume that a JSON dataset is valid just because json2dcm accepts it.
342-
This tool is not designed as a validator for JSON or the DICOM JSON model.
338+
Trailing commas are not permitted in JSON, but \b json2dcm will still accept
339+
such JSON data sets without warning or error message because they are handled
340+
gracefully by the underlying JSON parser. Users should, therefore, not assume
341+
that a JSON data set is valid just because \b json2dcm accepts it. This tool
342+
is not designed as a validator for JSON or the DICOM JSON Model.
343343

344344
\section json2dcm_logging LOGGING
345345

0 commit comments

Comments
 (0)