Skip to content

Commit 87ffb03

Browse files
Always use base_message instead of message in docblocks
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com> Co-authored-by: Jacob Perron <jacob@openrobotics.org>
1 parent 10eafc9 commit 87ffb03

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

rcljava_common/include/rcljava_common/exceptions.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
*
4545
* \param env a JNIEnv pointer, used to throw a java exception from the rcl error.
4646
* \param ret rcl_ret_t error that will be checked.
47-
* \param message error message that will be passed to the thrown exception.
48-
* The complete error will be "${message}: ${rcl_error_string}".
49-
* \a message can be either a `const char *` or as `std::string`.
47+
* \param base_message error message that will be passed to the thrown exception.
48+
* The complete error will be "${base_message}: ${rcl_error_string}".
49+
* \a base_message can be either a `const char *` or as `std::string`.
5050
* \param error_statement statement executed if ret was not RCL_RET_OK.
5151
*/
5252
#define RCLJAVA_COMMON_THROW_FROM_RCL_X(env, ret, base_message, error_statement) \

0 commit comments

Comments
 (0)