diff options
author | Morgan Deters <mdeters@gmail.com> | 2012-07-07 21:01:33 +0000 |
---|---|---|
committer | Morgan Deters <mdeters@gmail.com> | 2012-07-07 21:01:33 +0000 |
commit | 8b01efc32d61391d8d3cd2aaac0de49cd8e88ecc (patch) | |
tree | 9e61b253a66fc91ca86b11bc1cabae9e1a7394da /src/context | |
parent | 8166b6cef258b198d0ffc97d125da3c85acf9708 (diff) |
Various fixes to documentation---typos, some incomplete documentation fixed, \file tags corrected, copyright added to files that had it missing, etc.
I ensured that I didn't change any code with this commit, and even tested on the cluster to be doubly sure:
http://church.cims.nyu.edu/regress-results/compare_jobs.php?job_id=4655&reference_id=4646&p=0
Diffstat (limited to 'src/context')
-rw-r--r-- | src/context/cdhashmap_forward.h | 8 | ||||
-rw-r--r-- | src/context/cdhashset.h | 6 | ||||
-rw-r--r-- | src/context/cdhashset_forward.h | 8 | ||||
-rw-r--r-- | src/context/cdlist.h | 4 | ||||
-rw-r--r-- | src/context/cdmaybe.h | 29 |
5 files changed, 35 insertions, 20 deletions
diff --git a/src/context/cdhashmap_forward.h b/src/context/cdhashmap_forward.h index f1031fec4..593807f5c 100644 --- a/src/context/cdhashmap_forward.h +++ b/src/context/cdhashmap_forward.h @@ -1,11 +1,11 @@ /********************* */ -/*! \file cdmap_forward.h +/*! \file cdhashmap_forward.h ** \verbatim ** Original author: mdeters ** Major contributors: none - ** Minor contributors (to current version): none + ** Minor contributors (to current version): dejan ** This file is part of the CVC4 prototype. - ** Copyright (c) 2009, 2010, 2011 The Analysis of Computer Systems Group (ACSys) + ** Copyright (c) 2009-2012 The Analysis of Computer Systems Group (ACSys) ** Courant Institute of Mathematical Sciences ** New York University ** See the file COPYING in the top-level source directory for licensing @@ -20,7 +20,7 @@ ** public header context. ** ** For CDMap<> in particular, it's difficult to forward-declare it - ** yourself, becase it has a default template argument. + ** yourself, because it has a default template argument. **/ #include "cvc4_public.h" diff --git a/src/context/cdhashset.h b/src/context/cdhashset.h index bf1f7d097..7e15cf9eb 100644 --- a/src/context/cdhashset.h +++ b/src/context/cdhashset.h @@ -1,11 +1,11 @@ /********************* */ -/*! \file cdset.h +/*! \file cdhashset.h ** \verbatim ** Original author: mdeters ** Major contributors: none - ** Minor contributors (to current version): none + ** Minor contributors (to current version): dejan ** This file is part of the CVC4 prototype. - ** Copyright (c) 2009, 2010, 2011 The Analysis of Computer Systems Group (ACSys) + ** Copyright (c) 2009-2012 The Analysis of Computer Systems Group (ACSys) ** Courant Institute of Mathematical Sciences ** New York University ** See the file COPYING in the top-level source directory for licensing diff --git a/src/context/cdhashset_forward.h b/src/context/cdhashset_forward.h index dc7da22d2..01482ed34 100644 --- a/src/context/cdhashset_forward.h +++ b/src/context/cdhashset_forward.h @@ -1,11 +1,11 @@ /********************* */ -/*! \file cdset_forward.h +/*! \file cdhashset_forward.h ** \verbatim ** Original author: mdeters ** Major contributors: none - ** Minor contributors (to current version): none + ** Minor contributors (to current version): dejan ** This file is part of the CVC4 prototype. - ** Copyright (c) 2009, 2010, 2011 The Analysis of Computer Systems Group (ACSys) + ** Copyright (c) 2009-2012 The Analysis of Computer Systems Group (ACSys) ** Courant Institute of Mathematical Sciences ** New York University ** See the file COPYING in the top-level source directory for licensing @@ -20,7 +20,7 @@ ** public header context. ** ** For CDSet<> in particular, it's difficult to forward-declare it - ** yourself, becase it has a default template argument. + ** yourself, because it has a default template argument. **/ #include "cvc4_public.h" diff --git a/src/context/cdlist.h b/src/context/cdlist.h index 1630fa586..a63bd2d21 100644 --- a/src/context/cdlist.h +++ b/src/context/cdlist.h @@ -442,8 +442,8 @@ class CDList <T, CleanUp, ContextMemoryAllocator<T> > : public ContextObj { * * Explanation: * If ContextMemoryAllocator is used and d_list grows at a deeper context level - * the reallocated will be reallocated in a context memory regaion that can be - * detroyed on pop. To support this, a full copy of d_list would have to be made. + * the reallocated will be reallocated in a context memory region that can be + * destroyed on pop. To support this, a full copy of d_list would have to be made. * As this is unacceptable for performance in other situations, we do not do * this. */ diff --git a/src/context/cdmaybe.h b/src/context/cdmaybe.h index 3c95ab126..676025d03 100644 --- a/src/context/cdmaybe.h +++ b/src/context/cdmaybe.h @@ -1,8 +1,23 @@ -/** - * This implements a CDMaybe. - * This has either been set in the context or it has not. - * T must have a default constructor and support assignment. - */ +/********************* */ +/*! \file cdmaybe.h + ** \verbatim + ** Original author: taking + ** Major contributors: none + ** Minor contributors (to current version): none + ** This file is part of the CVC4 prototype. + ** Copyright (c) 2009-2012 The Analysis of Computer Systems Group (ACSys) + ** Courant Institute of Mathematical Sciences + ** New York University + ** See the file COPYING in the top-level source directory for licensing + ** information.\endverbatim + ** + ** \brief A context-dependent "maybe" template type + ** + ** This implements a CDMaybe. + ** This has either been set in the context or it has not. + ** Template parameter T must have a default constructor and support + ** assignment. + **/ #include "cvc4_private.h" @@ -33,7 +48,7 @@ public: d_flag.set(true); } -}; /* class CDRaised */ +};/* class CDRaised */ template <class T> class CDMaybe { @@ -58,7 +73,7 @@ public: Assert(isSet()); return d_data.get().second; } -}; /* class CDMaybe<T> */ +};/* class CDMaybe<T> */ }/* CVC4::context namespace */ }/* CVC4 namespace */ |