summaryrefslogtreecommitdiff
path: root/src/util/index.h
diff options
context:
space:
mode:
authorMorgan Deters <mdeters@gmail.com>2012-07-07 21:01:33 +0000
committerMorgan Deters <mdeters@gmail.com>2012-07-07 21:01:33 +0000
commit8b01efc32d61391d8d3cd2aaac0de49cd8e88ecc (patch)
tree9e61b253a66fc91ca86b11bc1cabae9e1a7394da /src/util/index.h
parent8166b6cef258b198d0ffc97d125da3c85acf9708 (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/util/index.h')
-rw-r--r--src/util/index.h25
1 files changed, 22 insertions, 3 deletions
diff --git a/src/util/index.h b/src/util/index.h
index 0c8b0a307..41afa12f2 100644
--- a/src/util/index.h
+++ b/src/util/index.h
@@ -1,3 +1,22 @@
+/********************* */
+/*! \file index.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 [[ Add one-line brief description here ]]
+ **
+ ** [[ Add lengthier description here ]]
+ ** \todo document this file
+ **/
+
#include "cvc4_private.h"
#pragma once
@@ -19,11 +38,11 @@ BOOST_STATIC_ASSERT(!std::numeric_limits<Index>::is_signed);
/* Discussion: Why is Index a uint32_t instead of size_t (or uint_fast32_t)?
*
- * size_t is a more appropraite choice than uint32_t as the choice is dictated by
+ * size_t is a more appropriate choice than uint32_t as the choice is dictated by
* uniqueness in arrays and vectors. These correspond to size_t.
- * However, the using size_t with a sizeof == 8 on 64 bit platforms is noticably
+ * However, the using size_t with a sizeof == 8 on 64 bit platforms is noticeably
* slower. (Limited testing suggests a ~1/16 of running time.)
* (Interestingly, uint_fast32_t also has a sizeof == 8 on x86_64. Filthy Liars!)
*/
-}; /* namespace CVC4 */
+}/* CVC4 namespace */
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback