Skip to content

Commit c4aaadf

Browse files
committed
code review: update doc comment
1 parent 7409dc7 commit c4aaadf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/viam/sdk/common/instance.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ class Instance {
2222
~Instance();
2323

2424
/// @brief Get the current Instance according to the Creation behavior.
25-
/// Calling current(Creation::open_existing) when an instance has not yet been constructed is an
26-
/// error.
25+
/// @throws an @ref Exception if current(Creation::open_existing) is called when an instance has
26+
/// not yet been constructed.
2727
static Instance& current(Creation);
2828

2929
private:

0 commit comments

Comments
 (0)