Skip to content

Commit 9fad7fa

Browse files
committed
chore(axiom): update comments
1 parent c058df8 commit 9fad7fa

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

axiom/nr_errors.h

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ extern nr_error_t* nr_error_create(int priority,
4040

4141
/*
4242
* Purpose : Create a new error for the use case where additional parameters are
43-
* passed in.
43+
* passed in. The following parameters are required and can not be NULL: klass
44+
* and stacktrace_json. If these are NULL, the function will return 0. The
45+
* remaining parameters can be passed in as NULL if they are not needed.
4446
*
4547
* Params : 1. The importance of the error. Higher number is more important.
4648
* 2. Message string.
@@ -77,62 +79,62 @@ extern nr_error_t* nr_error_create_additional_params(
7779
/*
7880
* Purpose : Get the message of an error.
7981
*
80-
* Returns : The message of the error or NULL on failure.
82+
* Returns : The message of the error or NULL if not defined.
8183
*/
8284
extern const char* nr_error_get_message(const nr_error_t* error);
8385
/*
8486
* Purpose : Get the klass of an error.
8587
*
86-
* Returns : The klass of the error or NULL on failure.
88+
* Returns : The klass of the error or NULL if not defined.
8789
*/
8890
extern const char* nr_error_get_klass(const nr_error_t* error);
8991

9092
/*
9193
* Purpose : Get the error file of an error.
9294
*
93-
* Returns : The error file of the error or NULL on failure.
95+
* Returns : The error file of the error or NULL if not defined.
9496
*/
9597
extern const char* nr_error_get_file(const nr_error_t* error);
9698

9799
/*
98100
* Purpose : Get the error line of an error.
99101
*
100-
* Returns : The error line of the error or 0 on failure.
102+
* Returns : The error line of the error or 0 if not defined.
101103
*/
102104
extern int nr_error_get_line(const nr_error_t* error);
103105

104106
/*
105107
* Purpose : Get the error context of an error.
106108
*
107-
* Returns : The error context of the error or NULL on failure.
109+
* Returns : The error context of the error or NULL if not defined.
108110
*/
109111
extern const char* nr_error_get_context(const nr_error_t* error);
110112

111113
/*
112114
* Purpose : Get the error number of an error.
113115
*
114-
* Returns : The error number of the error or 0 on failure.
116+
* Returns : The error number of the error or 0 if not defined.
115117
*/
116118
extern int nr_error_get_no(const nr_error_t* error);
117119

118120
/*
119121
* Purpose : Get the span_id of an error.
120122
*
121-
* Returns : The span_id of the error or NULL on failure.
123+
* Returns : The span_id of the error or NULL if not defined.
122124
*/
123125
extern const char* nr_error_get_span_id(const nr_error_t* error);
124126

125127
/*
126128
* Purpose : Get the time of an error.
127129
*
128-
* Returns : The time of the error or 0 on failure.
130+
* Returns : The time of the error or 0 if not defined.
129131
*/
130132
extern nrtime_t nr_error_get_time(const nr_error_t* error);
131133

132134
/*
133135
* Purpose : Get the priority of an error.
134136
*
135-
* Returns : The priority of the error or 0 on failure.
137+
* Returns : The priority of the error or 0 if not defined.
136138
*/
137139
extern int nr_error_priority(const nr_error_t* error);
138140

0 commit comments

Comments
 (0)