From 6853977be206b95f8e8ad10cbeac69602407ef0e Mon Sep 17 00:00:00 2001 From: Alexandre Duret-Lutz Date: Mon, 9 Aug 2004 13:43:55 +0000 Subject: [PATCH] * 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 | 7 +++++++ src/ltlast/allnodes.hh | 8 +++++++- src/ltlast/atomic_prop.hh | 2 ++ src/ltlast/binop.hh | 7 ++++++- src/ltlast/constant.hh | 4 +++- src/ltlast/formula.hh | 4 +++- src/ltlast/multop.hh | 4 +++- src/ltlast/predecl.hh | 9 ++++++++- src/ltlast/refformula.hh | 2 ++ src/ltlast/unop.hh | 4 +++- src/ltlast/visitor.hh | 4 +++- 11 files changed, 47 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index ce1c6be74..5f222f87c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2004-08-09 Alexandre Duret-Lutz + * 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. diff --git a/src/ltlast/allnodes.hh b/src/ltlast/allnodes.hh index f0b4b78ce..9b5664182 100644 --- a/src/ltlast/allnodes.hh +++ b/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 diff --git a/src/ltlast/atomic_prop.hh b/src/ltlast/atomic_prop.hh index e4d8864cc..a54117ffb 100644 --- a/src/ltlast/atomic_prop.hh +++ b/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 diff --git a/src/ltlast/binop.hh b/src/ltlast/binop.hh index 11dd1cff6..0197a28d4 100644 --- a/src/ltlast/binop.hh +++ b/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 diff --git a/src/ltlast/constant.hh b/src/ltlast/constant.hh index 156cae379..4eee4cd5c 100644 --- a/src/ltlast/constant.hh +++ b/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 diff --git a/src/ltlast/formula.hh b/src/ltlast/formula.hh index d3fa78528..6d15b8449 100644 --- a/src/ltlast/formula.hh +++ b/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 diff --git a/src/ltlast/multop.hh b/src/ltlast/multop.hh index af5cc2b11..60179fdf4 100644 --- a/src/ltlast/multop.hh +++ b/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 diff --git a/src/ltlast/predecl.hh b/src/ltlast/predecl.hh index 47039f13f..b28b80aa8 100644 --- a/src/ltlast/predecl.hh +++ b/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 diff --git a/src/ltlast/refformula.hh b/src/ltlast/refformula.hh index bd9f7f2a1..e6b99baa6 100644 --- a/src/ltlast/refformula.hh +++ b/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 diff --git a/src/ltlast/unop.hh b/src/ltlast/unop.hh index 4ab9dc15f..27ad95c19 100644 --- a/src/ltlast/unop.hh +++ b/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 diff --git a/src/ltlast/visitor.hh b/src/ltlast/visitor.hh index 12ff2964b..ba0445595 100644 --- a/src/ltlast/visitor.hh +++ b/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