* src/ltlast/allnodes.hh, src/ltlast/atomic_prop.hh,

src/ltlast/binop.hh, src/ltlast/constant.hh,
src/ltlast/formula.hh, src/ltlast/multop.hh,
src/ltlast/predecl.hh, src/ltlast/refformula.hh,
src/ltlast/unop.hh, src/ltlast/visitor.hh: Use file to introduce
each file.

ChangeLog

@@ -1,5 +1,12 @@
 2004-08-09  Alexandre Duret-Lutz  <adl@src.lip6.fr>
 
+	* src/ltlast/allnodes.hh, src/ltlast/atomic_prop.hh,
+	src/ltlast/binop.hh, src/ltlast/constant.hh,
+	src/ltlast/formula.hh, src/ltlast/multop.hh,
+	src/ltlast/predecl.hh, src/ltlast/refformula.hh,
+	src/ltlast/unop.hh, src/ltlast/visitor.hh: Use \file to introduce
+	each file.
+
 	* doc/Doxyfile.in (STRIP_FROM_INC_PATH): Define, so that the
 	`#include' references are correct.
 

src/ltlast/allnodes.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,12 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/allnodes.hh
+/// \brief Define all LTL node types.
+///
+/// This file is usually needed when \b defining a visitor.
+/// Prefer ltlast/predecl.hh when only \b declaring methods and functions
+/// over LTL nodes.
 #ifndef SPOT_LTLAST_ALLNODES_HH
 # define SPOT_LTLAST_ALLNODES_HH
 

src/ltlast/atomic_prop.hh

@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/atomic_prop.hh
+/// \brief LTL atomic propositions
 #ifndef SPOT_LTLAST_ATOMIC_PROP_HH
 # define SPOT_LTLAST_ATOMIC_PROP_HH
 

src/ltlast/binop.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,11 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/binop.hh
+/// \brief LTL binary operators
+///
+/// This does not include \c AND and \c OR operators.  These are
+/// considered to be multi-operand operators (see spot::ltl::multop).
 #ifndef SPOT_LTLAST_BINOP_HH
 # define SPOT_LTLAST_BINOP_HH
 

src/ltlast/constant.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/constant.hh
+/// \brief LTL constants
 #ifndef SPOT_LTLAST_CONSTANT_HH
 # define SPOT_LTLAST_CONSTANT_HH
 

src/ltlast/formula.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/formula.hh
+/// \brief LTL formula interface
 #ifndef SPOT_LTLAST_FORMULAE_HH
 # define SPOT_LTLAST_FORMULAE_HH
 

src/ltlast/multop.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/multop.hh
+/// \brief LTL multi-operand operators
 #ifndef SPOT_LTLAST_MULTOP_HH
 # define SPOT_LTLAST_MULTOP_HH
 

src/ltlast/predecl.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,13 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/predecl.hh
+/// \brief Predeclare all LTL node types.
+///
+/// This file is usually used when \b declaring methods and functions
+/// over LTL nodes.
+/// Use ltlast/allnodes.hh or an individual header when the definition of
+/// the node is actually needed.
 #ifndef SPOT_LTLAST_PREDECL_HH
 # define SPOT_LTLAST_PREDECL_HH
 

src/ltlast/refformula.hh

@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/refformula.hh
+/// \brief Reference-counted LTL formulae
 #ifndef SPOT_LTLAST_REFFORMULAE_HH
 # define SPOT_LTLAST_REFFORMULAE_HH
 

src/ltlast/unop.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/unop.hh
+/// \brief LTL unary operators
 #ifndef SPOT_LTLAST_UNOP_HH
 # define SPOT_LTLAST_UNOP_HH
 

src/ltlast/visitor.hh

@@ -1,4 +1,4 @@
-// Copyright (C) 2003  Laboratoire d'Informatique de Paris 6 (LIP6),
+// Copyright (C) 2003, 2004  Laboratoire d'Informatique de Paris 6 (LIP6),
 // département Systèmes Répartis Coopératifs (SRC), Université Pierre
 // et Marie Curie.
 //
@@ -19,6 +19,8 @@
 // Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 // 02111-1307, USA.
 
+/// \file ltlast/visitor.hh
+/// \brief LTL visitor interface
 #ifndef SPOT_LTLAST_VISITOR_HH
 # define SPOT_LTLAST_VISITOR_HH