From 138ce95cca20bcd990853ae8cb1d0264c6405082 Mon Sep 17 00:00:00 2001 From: Alexandre Duret-Lutz Date: Tue, 19 Aug 2003 14:01:48 +0000 Subject: [PATCH] * src/ltlast/formula.hh: Make it clear that ref() and unref() deals with one node, not a entire formula. --- ChangeLog | 5 +++++ src/ltlast/formula.hh | 14 ++++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index c60246c9e..919d4af56 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2003-08-19 Alexandre Duret-Lutz + + * src/ltlast/formula.hh: Make it clear that ref() and unref() + deals with one node, not a entire formula. + 2003-08-18 Alexandre Duret-Lutz * configure.ac: Bump version to 0.0i. diff --git a/src/ltlast/formula.hh b/src/ltlast/formula.hh index ea35d049d..75eba6793 100644 --- a/src/ltlast/formula.hh +++ b/src/ltlast/formula.hh @@ -22,9 +22,19 @@ namespace spot /// Entry point for vspot::ltl::const_visitor instances. virtual void accept(const_visitor& v) const = 0; - /// \brief clone this formula + /// \brief clone this node + /// + /// This increments the reference counter of this node (if one is + /// used). You should almost never use this method directly as + /// it doesn't touch the children. If you want to clone a + /// whole formula, use spot::ltl::clone() instead. formula* ref(); - /// \brief release formula + /// \brief release this node + /// + /// This decrements the reference counter of this node (if one is + /// used) and can free the object. You should almost never use + /// this method directly as it doesn't touch the children. If you + /// want to release a whole formula, use spot::ltl::destroy() instead. static void unref(formula* f); protected: