Skip to content

Commit 462f0b7

Browse files
ferdnycferdnyc
committed
Exception.h: Document parameters
1 parent 18c8b61 commit 462f0b7

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed

‎include/Exceptions.h‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@ namespace openshot {
6161
int64_t frame_number;
6262
int64_t chunk_number;
6363
int64_t chunk_frame;
64+
/**
65+
* @brief Constructor
66+
*
67+
* @param message A message to accompany the exception
68+
* @param frame_number The frame number being processed
69+
* @param chunk_number The chunk requested
70+
* @param chunk_frame The chunk frame
71+
*/
6472
ChunkNotFound(std::string message, int64_t frame_number, int64_t chunk_number, int64_t chunk_frame)
6573
: BaseException(message), frame_number(frame_number), chunk_number(chunk_number), chunk_frame(chunk_frame) { }
6674
virtual ~ChunkNotFound() noexcept {}
@@ -71,6 +79,11 @@ namespace openshot {
7179
class DecklinkError : public BaseException
7280
{
7381
public:
82+
/**
83+
* @brief Constructor
84+
*
85+
* @param message A message to accompany the exception
86+
*/
7487
DecklinkError(std::string message)
7588
: BaseException(message) { }
7689
virtual ~DecklinkError() noexcept {}
@@ -81,6 +94,12 @@ namespace openshot {
8194
{
8295
public:
8396
int64_t frame_number;
97+
/**
98+
* @brief Constructor
99+
*
100+
* @param message A message to accompany the exception
101+
* @param frame_number The frame number being processed
102+
*/
84103
ErrorDecodingAudio(std::string message, int64_t frame_number)
85104
: BaseException(message), frame_number(frame_number) { }
86105
virtual ~ErrorDecodingAudio() noexcept {}
@@ -91,6 +110,12 @@ namespace openshot {
91110
{
92111
public:
93112
int64_t frame_number;
113+
/**
114+
* @brief Constructor
115+
*
116+
* @param message A message to accompany the exception
117+
* @param frame_number The frame number being processed
118+
*/
94119
ErrorEncodingAudio(std::string message, int64_t frame_number)
95120
: BaseException(message), frame_number(frame_number) { }
96121
virtual ~ErrorEncodingAudio() noexcept {}
@@ -101,6 +126,12 @@ namespace openshot {
101126
{
102127
public:
103128
int64_t frame_number;
129+
/**
130+
* @brief Constructor
131+
*
132+
* @param message A message to accompany the exception
133+
* @param frame_number The frame number being processed
134+
*/
104135
ErrorEncodingVideo(std::string message, int64_t frame_number)
105136
: BaseException(message), frame_number(frame_number) { }
106137
virtual ~ErrorEncodingVideo() noexcept {}
@@ -111,6 +142,12 @@ namespace openshot {
111142
{
112143
public:
113144
std::string file_path;
145+
/**
146+
* @brief Constructor
147+
*
148+
* @param message A message to accompany the exception
149+
* @param file_path (optional) The input file being processed
150+
*/
114151
InvalidChannels(std::string message, std::string file_path="")
115152
: BaseException(message), file_path(file_path) { }
116153
virtual ~InvalidChannels() noexcept {}
@@ -121,6 +158,12 @@ namespace openshot {
121158
{
122159
public:
123160
std::string file_path;
161+
/**
162+
* @brief Constructor
163+
*
164+
* @param message A message to accompany the exception
165+
* @param file_path (optional) The input file being processed
166+
*/
124167
InvalidCodec(std::string message, std::string file_path="")
125168
: BaseException(message), file_path(file_path) { }
126169
virtual ~InvalidCodec() noexcept {}
@@ -131,6 +174,12 @@ namespace openshot {
131174
{
132175
public:
133176
std::string file_path;
177+
/**
178+
* @brief Constructor
179+
*
180+
* @param message A message to accompany the exception
181+
* @param file_path The input file being processed
182+
*/
134183
InvalidFile(std::string message, std::string file_path)
135184
: BaseException(message), file_path(file_path) { }
136185
virtual ~InvalidFile() noexcept {}
@@ -141,6 +190,12 @@ namespace openshot {
141190
{
142191
public:
143192
std::string file_path;
193+
/**
194+
* @brief Constructor
195+
*
196+
* @param message A message to accompany the exception
197+
* @param file_path (optional) The input file being processed
198+
*/
144199
InvalidFormat(std::string message, std::string file_path="")
145200
: BaseException(message), file_path(file_path) { }
146201
virtual ~InvalidFormat() noexcept {}
@@ -151,6 +206,12 @@ namespace openshot {
151206
{
152207
public:
153208
std::string file_path;
209+
/**
210+
* @brief Constructor
211+
*
212+
* @param message A message to accompany the exception
213+
* @param file_path (optional) The input file being processed
214+
*/
154215
InvalidJSON(std::string message, std::string file_path="")
155216
: BaseException(message), file_path(file_path) { }
156217
virtual ~InvalidJSON() noexcept {}
@@ -161,6 +222,12 @@ namespace openshot {
161222
{
162223
public:
163224
std::string file_path;
225+
/**
226+
* @brief Constructor
227+
*
228+
* @param message A message to accompany the exception
229+
* @param file_path (optional) The input file being processed
230+
*/
164231
InvalidOptions(std::string message, std::string file_path="")
165232
: BaseException(message), file_path(file_path) { }
166233
virtual ~InvalidOptions() noexcept {}
@@ -171,6 +238,12 @@ namespace openshot {
171238
{
172239
public:
173240
std::string file_path;
241+
/**
242+
* @brief Constructor
243+
*
244+
* @param message A message to accompany the exception
245+
* @param file_path (optional) The input file being processed
246+
*/
174247
InvalidSampleRate(std::string message, std::string file_path="")
175248
: BaseException(message), file_path(file_path) { }
176249
virtual ~InvalidSampleRate() noexcept {}
@@ -181,6 +254,12 @@ namespace openshot {
181254
{
182255
public:
183256
std::string json;
257+
/**
258+
* @brief Constructor
259+
*
260+
* @param message A message to accompany the exception
261+
* @param json The json data being processed
262+
*/
184263
InvalidJSONKey(std::string message, std::string json)
185264
: BaseException(message), json(json) { }
186265
virtual ~InvalidJSONKey() noexcept {}
@@ -191,6 +270,12 @@ namespace openshot {
191270
{
192271
public:
193272
std::string file_path;
273+
/**
274+
* @brief Constructor
275+
*
276+
* @param message A message to accompany the exception
277+
* @param file_path (optional) The input file being processed
278+
*/
194279
NoStreamsFound(std::string message, std::string file_path="")
195280
: BaseException(message), file_path(file_path) { }
196281
virtual ~NoStreamsFound() noexcept {}
@@ -202,6 +287,13 @@ namespace openshot {
202287
public:
203288
int64_t FrameRequested;
204289
int64_t MaxFrames;
290+
/**
291+
* @brief Constructor
292+
*
293+
* @param message A message to accompany the exception
294+
* @param frame_requested The out-of-bounds frame number requested
295+
* @param max_frames The maximum available frame number
296+
*/
205297
OutOfBoundsFrame(std::string message, int64_t frame_requested, int64_t max_frames)
206298
: BaseException(message), FrameRequested(frame_requested), MaxFrames(max_frames) { }
207299
virtual ~OutOfBoundsFrame() noexcept {}
@@ -213,6 +305,13 @@ namespace openshot {
213305
public:
214306
int PointRequested;
215307
int MaxPoints;
308+
/**
309+
* @brief Constructor
310+
*
311+
* @param message A message to accompany the exception
312+
* @param point_requested The out-of-bounds point requested
313+
* @param max_points The maximum available point value
314+
*/
216315
OutOfBoundsPoint(std::string message, int point_requested, int max_points)
217316
: BaseException(message), PointRequested(point_requested), MaxPoints(max_points) { }
218317
virtual ~OutOfBoundsPoint() noexcept {}
@@ -223,6 +322,12 @@ namespace openshot {
223322
{
224323
public:
225324
std::string file_path;
325+
/**
326+
* @brief Constructor
327+
*
328+
* @param message A message to accompany the exception
329+
* @param file_path (optional) The input file being processed
330+
*/
226331
OutOfMemory(std::string message, std::string file_path="")
227332
: BaseException(message), file_path(file_path) { }
228333
virtual ~OutOfMemory() noexcept {}
@@ -233,6 +338,12 @@ namespace openshot {
233338
{
234339
public:
235340
std::string file_path;
341+
/**
342+
* @brief Constructor
343+
*
344+
* @param message A message to accompany the exception
345+
* @param file_path (optional) The input file being processed
346+
*/
236347
ReaderClosed(std::string message, std::string file_path="")
237348
: BaseException(message), file_path(file_path) { }
238349
virtual ~ReaderClosed() noexcept {}
@@ -243,6 +354,12 @@ namespace openshot {
243354
{
244355
public:
245356
std::string file_path;
357+
/**
358+
* @brief Constructor
359+
*
360+
* @param message A message to accompany the exception
361+
* @param file_path (optional) The input file being processed
362+
*/
246363
ResampleError(std::string message, std::string file_path="")
247364
: BaseException(message), file_path(file_path) { }
248365
virtual ~ResampleError() noexcept {}
@@ -253,6 +370,12 @@ namespace openshot {
253370
{
254371
public:
255372
std::string file_path;
373+
/**
374+
* @brief Constructor
375+
*
376+
* @param message A message to accompany the exception
377+
* @param file_path (optional) The input file being processed
378+
*/
256379
TooManySeeks(std::string message, std::string file_path="")
257380
: BaseException(message), file_path(file_path) { }
258381
virtual ~TooManySeeks() noexcept {}
@@ -263,6 +386,12 @@ namespace openshot {
263386
{
264387
public:
265388
std::string file_path;
389+
/**
390+
* @brief Constructor
391+
*
392+
* @param message A message to accompany the exception
393+
* @param file_path (optional) The output file being written
394+
*/
266395
WriterClosed(std::string message, std::string file_path="")
267396
: BaseException(message), file_path(file_path) { }
268397
virtual ~WriterClosed() noexcept {}

0 commit comments

Comments
 (0)