Update/Fix documentation for BDD and ZDD predicates

src/adiar/bdd.h

@@ -1040,7 +1040,8 @@ namespace adiar
   /// \{
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the variable labels in \em ascending order.
+  /// \brief Get (in \em ascending order) all of the variable labels that occur
+  ///        in the BDD.
   ///
   /// \param f  BDD of interest.
   ///
@@ -1049,8 +1050,8 @@ namespace adiar
   void bdd_support(const bdd &f, const consumer<bdd::label_type> &cb);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Copy the variable labels (in \em ascending order) into the given
-  ///        container.
+  /// \brief Copy all of the variable labels (in \em ascending order) that occur
+  ///        in the BDD into the given container.
   ///
   /// \param f     BDD of interest.
   ///
@@ -1078,14 +1079,14 @@ namespace adiar
   bdd::label_type bdd_topvar(const bdd &f);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the minimal occurring variable in this BDD.
+  /// \brief Get the minimal occurring variable in the function's support.
   ///
   /// \throws invalid_argument If `f` is a terminal.
   //////////////////////////////////////////////////////////////////////////////
   bdd::label_type bdd_minvar(const bdd &f);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the maximal occurring variable in this BDD.
+  /// \brief Get the maximal occurring variable in the function's support.
   ///
   /// \throws invalid_argument If `f` is a terminal.
   //////////////////////////////////////////////////////////////////////////////

src/adiar/zdd.h

@@ -1080,7 +1080,8 @@ namespace adiar
   /// \{
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the variable labels in \em ascending order.
+  /// \brief Get (in \em ascending order) all of the variable labels that occur
+  ///        in the family.
   ///
   /// \param A  ZDD of interest.
   ///
@@ -1089,8 +1090,8 @@ namespace adiar
   void zdd_support(const zdd &A, const consumer<zdd::label_type> &cb);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Copy the variable labels (in \em ascending order) into the given
-  ///        container.
+  /// \brief Copy all of the variable labels (in \em ascending order) that occur
+  ///        in the family into the given container.
   ///
   /// \param A     ZDD of interest.
   ///
@@ -1113,21 +1114,21 @@ namespace adiar
   //////////////////////////////////////////////////////////////////////////////
   /// \brief Get the root's variable label.
   ///
-  /// \throws invalid_argument If `f` is a terminal.
+  /// \throws invalid_argument If `A` is a terminal.
   //////////////////////////////////////////////////////////////////////////////
   zdd::label_type zdd_topvar(const zdd &f);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the minimal occurring variable in this ZDD.
+  /// \brief Get the minimal occurring variable in the family.
   ///
-  /// \throws invalid_argument If `f` is a terminal.
+  /// \throws invalid_argument If `A` is a terminal.
   //////////////////////////////////////////////////////////////////////////////
   zdd::label_type zdd_minvar(const zdd &A);
 
   //////////////////////////////////////////////////////////////////////////////
-  /// \brief Get the maximal occurring variable in this ZDD.
+  /// \brief Get the maximal occurring variable in the family.
   ///
-  /// \throws invalid_argument If `f` is a terminal.
+  /// \throws invalid_argument If `A` is a terminal.
   //////////////////////////////////////////////////////////////////////////////
   zdd::label_type zdd_maxvar(const zdd &A);