Skip to content

Commit

Permalink
Fix doc comment for exception::line_number() (#901)
Browse files Browse the repository at this point in the history
The documentation comment for `exception::line_number()` in
`include/etl/exception.h` states falsely that the return type for
the function is a `const char*`.

It should state that the return type is `numeric_type`,
which is an `int`.

So change the documentation comment to reflect that the return type is
an `int`.
  • Loading branch information
SakuGlumoff authored Jun 4, 2024
1 parent 8bf527e commit 496c8a2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion include/etl/exception.h
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ namespace etl

//***************************************************************************
/// Gets the line for the exception.
/// \return const char* to the line.
/// \return int as line number.
//***************************************************************************
ETL_CONSTEXPR
numeric_type line_number() const
Expand Down

0 comments on commit 496c8a2

Please sign in to comment.