Skip to content

Commit

Permalink
Adding additional documentation for the behavior between Set<T> and R…
Browse files Browse the repository at this point in the history
…eparse

Signed-off-by: Aaron Chong <[email protected]>
  • Loading branch information
aaronchongth committed Sep 2, 2021
1 parent 2099a3c commit e901780
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion include/sdf/Param.hh
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,11 @@ namespace sdf
public: void Reset();

/// \brief Reparse the parameter value, this is usually called after the
/// parent element's attributes have been modified.
/// parent element's attributes have been modified. If however the value was
/// explicitly set using the Set<T> function, reparsing would not change the
/// value.
/// \return True if the parameter value has been reparsed successfully.
/// \sa bool Set(const T &_value)
public: bool Reparse();

/// \brief Get the key value.
Expand Down

0 comments on commit e901780

Please sign in to comment.