Skip to content

Commit 2dd52e0

Browse files
asmaloneyasmaloney
committed
{ci, doc} Fix clang -documentation warnings
clang 17 complains about documentation of the form: @throw ::ErrorImageFileNotOpen with this warning/error: error: empty paragraph passed to '@throw' command [-Werror,-Wdocumentation] Add text to stop it complaining.
1 parent 7e3079b commit 2dd52e0

14 files changed

Lines changed: 218 additions & 228 deletions

‎include/E57SimpleData.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,8 +634,8 @@ namespace e57
634634
635635
@param [in] data3D Completed header which indicates the fields we are using
636636
637-
@throw ::ErrorValueOutOfBounds
638-
@throw ::ErrorInvalidNodeType
637+
@throw ::ErrorValueOutOfBounds (n/c)
638+
@throw ::ErrorInvalidNodeType (n/c)
639639
*/
640640
explicit Data3DPointsData_t( e57::Data3D &data3D );
641641

‎src/BlobNode.cpp‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ is an error to attempt to attach the BlobNode to a different ImageFile.
126126
must be true).
127127
@pre byteCount >= 0
128128
129-
@throw ::ErrorBadAPIArgument
130-
@throw ::ErrorImageFileNotOpen
131-
@throw ::ErrorFileReadOnly
132-
@throw ::ErrorInternal All objects in undocumented state
129+
@throw ::ErrorBadAPIArgument (n/c)
130+
@throw ::ErrorImageFileNotOpen (n/c)
131+
@throw ::ErrorFileReadOnly (n/c)
132+
@throw ::ErrorInternal All objects in undocumented state (n/c)
133133
134134
@see Node, BlobNode::read, BlobNode::write
135135
*/
@@ -200,7 +200,7 @@ bool BlobNode::isAttached() const
200200
201201
@return The declared size of the blob when it was created.
202202
203-
@throw ::ErrorImageFileNotOpen
203+
@throw ::ErrorImageFileNotOpen (n/c)
204204
@throw ::ErrorInternal All objects in undocumented state
205205
206206
@see BlobNode::read, BlobNode::write
@@ -233,11 +233,11 @@ zero or more times.
233233
@pre 0 <= count
234234
@pre (@a start + @a count) < byteCount()
235235
236-
@throw ::ErrorBadAPIArgument
237-
@throw ::ErrorImageFileNotOpen
238-
@throw ::ErrorSeekFailed
239-
@throw ::ErrorReadFailed
240-
@throw ::ErrorBadChecksum
236+
@throw ::ErrorBadAPIArgument (n/c)
237+
@throw ::ErrorImageFileNotOpen (n/c)
238+
@throw ::ErrorSeekFailed (n/c)
239+
@throw ::ErrorReadFailed (n/c)
240+
@throw ::ErrorBadChecksum (n/c)
241241
@throw ::ErrorInternal All objects in undocumented state
242242
243243
@see BlobNode::byteCount, BlobNode::write
@@ -276,14 +276,14 @@ destImageFile().isWritable()).
276276
@pre 0 <= count
277277
@pre (@a start + @a count) < byteCount()
278278
279-
@throw ::ErrorBadAPIArgument
280-
@throw ::ErrorImageFileNotOpen
281-
@throw ::ErrorFileReadOnly
282-
@throw ::ErrorNodeUnattached
283-
@throw ::ErrorSeekFailed
284-
@throw ::ErrorReadFailed
285-
@throw ::ErrorWriteFailed
286-
@throw ::ErrorBadChecksum
279+
@throw ::ErrorBadAPIArgument (n/c)
280+
@throw ::ErrorImageFileNotOpen (n/c)
281+
@throw ::ErrorFileReadOnly (n/c)
282+
@throw ::ErrorNodeUnattached (n/c)
283+
@throw ::ErrorSeekFailed (n/c)
284+
@throw ::ErrorReadFailed (n/c)
285+
@throw ::ErrorWriteFailed (n/c)
286+
@throw ::ErrorBadChecksum (n/c)
287287
@throw ::ErrorInternal All objects in undocumented state
288288
289289
@see BlobNode::byteCount, BlobNode::read
@@ -340,7 +340,7 @@ The handle @a n must be for an underlying BlobNode, otherwise an exception is th
340340
that need to avoid the exception, use Node::type() to determine the actual type of the @a n before
341341
downcasting. This function must be explicitly called (c++ compiler cannot insert it automatically).
342342
343-
@throw ::ErrorBadNodeDowncast
343+
@throw ::ErrorBadNodeDowncast (n/c)
344344
345345
@see Node::type(), BlobNode::operator Node()
346346
*/

‎src/CompressedVectorNode.cpp‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -197,12 +197,12 @@ prototype.isRoot())
197197
@post prototype.isAttached()
198198
@post codecs.isAttached()
199199
200-
@throw ::ErrorImageFileNotOpen
201-
@throw ::ErrorFileReadOnly
202-
@throw ::ErrorBadPrototype
203-
@throw ::ErrorBadCodecs
204-
@throw ::ErrorAlreadyHasParent
205-
@throw ::ErrorDifferentDestImageFile
200+
@throw ::ErrorImageFileNotOpen (n/c)
201+
@throw ::ErrorFileReadOnly (n/c)
202+
@throw ::ErrorBadPrototype (n/c)
203+
@throw ::ErrorBadCodecs (n/c)
204+
@throw ::ErrorAlreadyHasParent (n/c)
205+
@throw ::ErrorDifferentDestImageFile (n/c)
206206
@throw ::ErrorInternal All objects in undocumented state
207207
208208
@see SourceDestBuffer, Node, CompressedVectorNode::reader, CompressedVectorNode::writer
@@ -275,7 +275,7 @@ any writes completed.
275275
276276
@return Current number of records in CompressedVectorNode.
277277
278-
@throw ::ErrorImageFileNotOpen
278+
@throw ::ErrorImageFileNotOpen (n/c)
279279
@throw ::ErrorInternal All objects in undocumented state
280280
281281
@see CompressedVectorNode::reader, CompressedVectorNode::writer
@@ -293,7 +293,7 @@ int64_t CompressedVectorNode::childCount() const
293293
294294
@return A smart Node handle referencing the root of the prototype tree.
295295
296-
@throw ::ErrorImageFileNotOpen
296+
@throw ::ErrorImageFileNotOpen (n/c)
297297
@throw ::ErrorInternal All objects in undocumented state
298298
299299
@see CompressedVectorNode::CompressedVectorNode, SourceDestBuffer, CompressedVectorNode::reader,
@@ -313,7 +313,7 @@ CompressedVectorNode.
313313
314314
@return A smart VectorNode handle referencing the root of the codecs tree.
315315
316-
@throw ::ErrorImageFileNotOpen
316+
@throw ::ErrorImageFileNotOpen (n/c)
317317
@throw ::ErrorInternal All objects in undocumented state
318318
319319
@see CompressedVectorNode::CompressedVectorNode, SourceDestBuffer, CompressedVectorNode::reader,
@@ -372,7 +372,7 @@ designs that need to avoid the exception, use Node::type() to determine the actu
372372
before downcasting. This function must be explicitly called (c++ compiler cannot insert it
373373
automatically).
374374
375-
@throw ::ErrorBadNodeDowncast
375+
@throw ::ErrorBadNodeDowncast (n/c)
376376
377377
@see Node::type(), CompressedVectorNode::operator, Node()
378378
*/
@@ -422,17 +422,17 @@ CompressedVectorNode cannot be set twice).
422422
423423
@return A smart CompressedVectorWriter handle referencing the underlying iterator object.
424424
425-
@throw ::ErrorBadAPIArgument
426-
@throw ::ErrorImageFileNotOpen
427-
@throw ::ErrorFileReadOnly
428-
@throw ::ErrorSetTwice
429-
@throw ::ErrorTooManyWriters
430-
@throw ::ErrorTooManyReaders
431-
@throw ::ErrorNodeUnattached
432-
@throw ::ErrorPathUndefined
433-
@throw ::ErrorBufferSizeMismatch
434-
@throw ::ErrorBufferDuplicatePathName
435-
@throw ::ErrorNoBufferForElement
425+
@throw ::ErrorBadAPIArgument (n/c)
426+
@throw ::ErrorImageFileNotOpen (n/c)
427+
@throw ::ErrorFileReadOnly (n/c)
428+
@throw ::ErrorSetTwice (n/c)
429+
@throw ::ErrorTooManyWriters (n/c)
430+
@throw ::ErrorTooManyReaders (n/c)
431+
@throw ::ErrorNodeUnattached (n/c)
432+
@throw ::ErrorPathUndefined (n/c)
433+
@throw ::ErrorBufferSizeMismatch (n/c)
434+
@throw ::ErrorBufferDuplicatePathName (n/c)
435+
@throw ::ErrorNoBufferForElement (n/c)
436436
@throw ::ErrorInternal All objects in undocumented state
437437
438438
@see CompressedVectorWriter, SourceDestBuffer, CompressedVectorNode::CompressedVectorNode,
@@ -461,14 +461,14 @@ prototype. It is not an error to create a CompressedVectorReader for an empty Co
461461
462462
@return A smart CompressedVectorReader handle referencing the underlying iterator object.
463463
464-
@throw ::ErrorBadAPIArgument
465-
@throw ::ErrorImageFileNotOpen
466-
@throw ::ErrorTooManyWriters
467-
@throw ::ErrorNodeUnattached
468-
@throw ::ErrorPathUndefined
469-
@throw ::ErrorBufferSizeMismatch
470-
@throw ::ErrorBufferDuplicatePathName
471-
@throw ::ErrorBadCVHeader
464+
@throw ::ErrorBadAPIArgument (n/c)
465+
@throw ::ErrorImageFileNotOpen (n/c)
466+
@throw ::ErrorTooManyWriters (n/c)
467+
@throw ::ErrorNodeUnattached (n/c)
468+
@throw ::ErrorPathUndefined (n/c)
469+
@throw ::ErrorBufferSizeMismatch (n/c)
470+
@throw ::ErrorBufferDuplicatePathName (n/c)
471+
@throw ::ErrorBadCVHeader (n/c)
472472
@throw ::ErrorInternal All objects in undocumented state
473473
474474
@see CompressedVectorReader, SourceDestBuffer, CompressedVectorNode::CompressedVectorNode,

‎src/CompressedVectorReader.cpp‎

Lines changed: 27 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -162,29 +162,19 @@ destroyed.
162162
163163
@return The number of records read.
164164
165-
@throw ::ErrorImageFileNotOpen
166-
@throw ::ErrorReaderNotOpen
167-
@throw ::ErrorConversionRequired This CompressedVectorReader
168-
in undocumented state
169-
@throw ::ErrorValueNotRepresentable This CompressedVectorReader
170-
in undocumented state
171-
@throw ::ErrorScaledValueNotRepresentable This CompressedVectorReader
172-
in undocumented state
173-
@throw ::ErrorReal64TooLarge This CompressedVectorReader
174-
in undocumented state
175-
@throw ::ErrorExpectingNumeric This CompressedVectorReader
176-
in undocumented state
177-
@throw ::ErrorExpectingUString This CompressedVectorReader
178-
in undocumented state
179-
@throw ::ErrorBadCVPacket This CompressedVectorReader, associated
180-
ImageFile in undocumented state
181-
@throw ::ErrorSeekFailed This CompressedVectorReader, associated
182-
ImageFile in undocumented state
183-
@throw ::ErrorReadFailed This CompressedVectorReader, associated
184-
ImageFile in undocumented state
185-
@throw ::ErrorBadChecksum This CompressedVectorReader, associated
186-
ImageFile in undocumented state
187-
@throw ::ErrorInternal All objects in undocumented state
165+
@throw ::ErrorImageFileNotOpen (n/c)
166+
@throw ::ErrorReaderNotOpen (n/c)
167+
@throw ::ErrorConversionRequired This CompressedVectorReader in undocumented state
168+
@throw ::ErrorValueNotRepresentable This CompressedVectorReader in undocumented state
169+
@throw ::ErrorScaledValueNotRepresentable This CompressedVectorReader in undocumented state
170+
@throw ::ErrorReal64TooLarge This CompressedVectorReader in undocumented state
171+
@throw ::ErrorExpectingNumeric This CompressedVectorReader in undocumented state
172+
@throw ::ErrorExpectingUString This CompressedVectorReader in undocumented state
173+
@throw ::ErrorBadCVPacket This CompressedVectorReader, associated ImageFile in undocumented state
174+
@throw ::ErrorSeekFailed This CompressedVectorReader, associated ImageFile in undocumented state
175+
@throw ::ErrorReadFailed This CompressedVectorReader, associated ImageFile in undocumented state
176+
@throw ::ErrorBadChecksum This CompressedVectorReader, associated ImageFile in undocumented state
177+
@throw ::ErrorInternal All objects in undocumented state
188178
189179
@see CompressedVectorReader::read(std::vector<SourceDestBuffer>&),
190180
CompressedVectorNode::reader, SourceDestBuffer,
@@ -230,11 +220,11 @@ detect that a memory buffer been destroyed.
230220
231221
@return The number of records read.
232222
233-
@throw ::ErrorImageFileNotOpen
234-
@throw ::ErrorReaderNotOpen
235-
@throw ::ErrorPathUndefined
236-
@throw ::ErrorBufferSizeMismatch
237-
@throw ::ErrorBufferDuplicatePathName
223+
@throw ::ErrorImageFileNotOpen nc
224+
@throw ::ErrorReaderNotOpen (n/c)
225+
@throw ::ErrorPathUndefined (n/c)
226+
@throw ::ErrorBufferSizeMismatch (n/c)
227+
@throw ::ErrorBufferDuplicatePathName (n/c)
238228
@throw ::ErrorConversionRequired This CompressedVectorReader in undocumented state
239229
@throw ::ErrorValueNotRepresentable This CompressedVectorReader in undocumented state
240230
@throw ::ErrorScaledValueNotRepresentable This CompressedVectorReader in undocumented state
@@ -269,13 +259,13 @@ childCount() (i.e. to one record past end of CompressedVectorNode).
269259
@pre The associated ImageFile must be open.
270260
@pre This CompressedVectorReader must be open (i.e isOpen())
271261
272-
@throw ::ErrorBadAPIArgument
273-
@throw ::ErrorImageFileNotOpen
274-
@throw ::ErrorReaderNotOpen
275-
@throw ::ErrorBadCVPacket
276-
@throw ::ErrorSeekFailed
277-
@throw ::ErrorReadFailed
278-
@throw ::ErrorBadChecksum
262+
@throw ::ErrorBadAPIArgument (n/c)
263+
@throw ::ErrorImageFileNotOpen (n/c)
264+
@throw ::ErrorReaderNotOpen (n/c)
265+
@throw ::ErrorBadCVPacket (n/c)
266+
@throw ::ErrorSeekFailed (n/c)
267+
@throw ::ErrorReadFailed (n/c)
268+
@throw ::ErrorBadChecksum (n/c)
279269
@throw ::ErrorInternal All objects in undocumented state
280270
281271
@see CompressedVectorNode::reader
@@ -308,7 +298,7 @@ void CompressedVectorReader::close()
308298
309299
@pre The associated ImageFile must be open.
310300
311-
@throw ::ErrorImageFileNotOpen
301+
@throw ::ErrorImageFileNotOpen (n/c)
312302
@throw ::ErrorInternal All objects in undocumented state
313303
314304
@see CompressedVectorReader::close, CompressedVectorNode::reader
@@ -328,7 +318,7 @@ It is not an error if this CompressedVectorReader is closed.
328318
329319
@return A smart CompressedVectorNode handle referencing the underlying object being read from.
330320
331-
@throw ::ErrorImageFileNotOpen
321+
@throw ::ErrorImageFileNotOpen (n/c)
332322
@throw ::ErrorInternal All objects in undocumented state
333323
334324
@see CompressedVectorReader::close, CompressedVectorNode::reader

‎src/CompressedVectorWriter.cpp‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -152,13 +152,13 @@ all writes to the CompressedVectorNode will be lost (it will have zero children)
152152
@pre The associated ImageFile must be open.
153153
@pre This CompressedVectorWriter must be open (i.e isOpen())
154154
155-
@throw ::ErrorBadAPIArgument
156-
@throw ::ErrorImageFileNotOpen
157-
@throw ::ErrorWriterNotOpen
158-
@throw ::ErrorPathUndefined
159-
@throw ::ErrorNoBufferForElement
160-
@throw ::ErrorBufferSizeMismatch
161-
@throw ::ErrorBufferDuplicatePathName
155+
@throw ::ErrorBadAPIArgument (n/c)
156+
@throw ::ErrorImageFileNotOpen (n/c)
157+
@throw ::ErrorWriterNotOpen (n/c)
158+
@throw ::ErrorPathUndefined (n/c)
159+
@throw ::ErrorNoBufferForElement (n/c)
160+
@throw ::ErrorBufferSizeMismatch (n/c)
161+
@throw ::ErrorBufferDuplicatePathName (n/c)
162162
@throw ::ErrorConversionRequired This CompressedVectorWriter in undocumented state, associated
163163
CompressedVectorNode modified but consistent, associated ImageFile modified but consistent.
164164
@throw ::ErrorValueOutOfBounds This CompressedVectorWriter in undocumented state, associated
@@ -218,13 +218,13 @@ is invoked, all writes to the CompressedVectorNode will be lost (it will have ze
218218
@pre The associated ImageFile must be open.
219219
@pre This CompressedVectorWriter must be open (i.e isOpen())
220220
221-
@throw ::ErrorBadAPIArgument
222-
@throw ::ErrorImageFileNotOpen
223-
@throw ::ErrorWriterNotOpen
224-
@throw ::ErrorPathUndefined
225-
@throw ::ErrorNoBufferForElement
226-
@throw ::ErrorBufferSizeMismatch
227-
@throw ::ErrorBufferDuplicatePathName
221+
@throw ::ErrorBadAPIArgument (n/c)
222+
@throw ::ErrorImageFileNotOpen (n/c)
223+
@throw ::ErrorWriterNotOpen (n/c)
224+
@throw ::ErrorPathUndefined (n/c)
225+
@throw ::ErrorNoBufferForElement (n/c)
226+
@throw ::ErrorBufferSizeMismatch (n/c)
227+
@throw ::ErrorBufferDuplicatePathName (n/c)
228228
@throw ::ErrorConversionRequired This CompressedVectorWriter in undocumented state, associated
229229
ImageFile modified but consistent.
230230
@throw ::ErrorValueOutOfBounds This CompressedVectorWriter in undocumented state, associated
@@ -269,7 +269,7 @@ writes to the CompressedVectorNode will be lost (it will have zero children).
269269
@pre The associated ImageFile must be open.
270270
@post This CompressedVectorWriter is closed (i.e !isOpen())
271271
272-
@throw ::ErrorImageFileNotOpen
272+
@throw ::ErrorImageFileNotOpen (n/c)
273273
@throw ::ErrorSeekFailed This CompressedVectorWriter, associated ImageFile in undocumented state
274274
@throw ::ErrorReadFailed This CompressedVectorWriter, associated ImageFile in undocumented state
275275
@throw ::ErrorWriteFailed This CompressedVectorWriter, associated ImageFile in undocumented state
@@ -288,7 +288,7 @@ void CompressedVectorWriter::close()
288288
289289
@pre The associated ImageFile must be open.
290290
291-
@throw ::ErrorImageFileNotOpen
291+
@throw ::ErrorImageFileNotOpen (n/c)
292292
@throw ::ErrorInternal All objects in undocumented state
293293
294294
@see CompressedVectorWriter::close, CompressedVectorNode::writer
@@ -305,7 +305,7 @@ bool CompressedVectorWriter::isOpen()
305305
306306
@return A smart CompressedVectorNode handle referencing the underlying object being written to.
307307
308-
@throw ::ErrorImageFileNotOpen
308+
@throw ::ErrorImageFileNotOpen (n/c)
309309
@throw ::ErrorInternal All objects in undocumented state
310310
311311
@see CompressedVectorNode::writer

0 commit comments

Comments
 (0)