Add clarification about the need to explicitly switch back to the tem…

…porary association
SSoelvsten · May 29, 2024 · 75af1be · 75af1be
1 parent c69cf30
commit 75af1be
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/cal.h b/src/cal.h
@@ -388,6 +388,9 @@ EXTERN void Cal_AssociationQuit(Cal_BddManager bddManager, int associationId);
 ////////////////////////////////////////////////////////////////////////////////
 /// \brief Sets the current variable association to the one given.
 ///
+/// \param associationId The id of the association to currently use. Set it to
+/// -1 if the temporary association should be used.
+///
 /// \returns ID of the prior association (if any). A return value of -1
 /// indicates the temporary association.
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/src/calObj.hh b/src/calObj.hh
@@ -1106,6 +1106,9 @@ public:
   //////////////////////////////////////////////////////////////////////////////
   /// \brief Sets the current variable association to the one given.
   ///
+  /// \param i The id of the association to currently use. Set it to -1 if the
+  /// temporary association should be used.
+  ///
   /// \returns ID of the prior association (if any). A return value of -1
   /// indicates the temporary association.
   ///