From e5991c76f9aa744220ade6d8a459a683b1fcce9b Mon Sep 17 00:00:00 2001
From: Owen <owen.jones@diffblue.com>
Date: Mon, 25 Feb 2019 16:00:14 +0000
Subject: [PATCH] Replace "entry" with "element" in function docs

"Entry" has a specific meaning in this file, because of entryt. The
function docs for object_map_dt use it to mean an element in a map.
Change them to use "element" instead.
---
 src/pointer-analysis/value_set.h | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/pointer-analysis/value_set.h b/src/pointer-analysis/value_set.h
index 4083c8b2c85..6f6b1dabb60 100644
--- a/src/pointer-analysis/value_set.h
+++ b/src/pointer-analysis/value_set.h
@@ -139,7 +139,7 @@ class value_sett
     ~object_map_dt()=default;
   };
 
-  /// Converts an `object_map_dt` entry `object_number -> offset` into an
+  /// Converts an `object_map_dt` element `object_number -> offset` into an
   /// `object_descriptor_exprt` with
   /// `.object() == object_numbering.at(object_number)` and
   /// `.offset() == offset`.
@@ -159,29 +159,29 @@ class value_sett
   /// be shared between the two `value_sett` instances.
   typedef reference_counting<object_map_dt> object_mapt;
 
-  /// Sets an entry in object map `dest` to match an existing entry `it`
-  /// from a different map. Any existing entry for the same `exprt` is
+  /// Sets an element in object map `dest` to match an existing element `it`
+  /// from a different map. Any existing element for the same `exprt` is
   /// overwritten.
   /// \param dest: object map to update.
-  /// \param it: iterator pointing to new entry
+  /// \param it: iterator pointing to new element
   void set(object_mapt &dest, const object_map_dt::value_type &it) const
   {
     dest.write()[it.first]=it.second;
   }
 
-  /// Merges an existing entry into an object map. If the destination map
-  /// has an existing entry for the same expression with a different offset
+  /// Merges an existing element into an object map. If the destination map
+  /// has an existing element for the same expression with a different offset
   /// its offset is marked unknown (so e.g. `x -> 0` and `x -> 1` merge into
   /// `x -> ?`).
   /// \param dest: object map to update.
-  /// \param it: iterator pointing to new entry
+  /// \param it: iterator pointing to new element
   bool insert(object_mapt &dest, const object_map_dt::value_type &it) const
   {
     return insert(dest, it.first, it.second);
   }
 
   /// Adds an expression to an object map, with unknown offset. If the
-  /// destination map has an existing entry for the same expression
+  /// destination map has an existing element for the same expression
   /// its offset is marked unknown.
   /// \param dest: object map to update
   /// \param src: expression to add
@@ -191,7 +191,7 @@ class value_sett
   }
 
   /// Adds an expression to an object map, with known offset. If the
-  /// destination map has an existing entry for the same expression
+  /// destination map has an existing element for the same expression
   /// with a differing offset its offset is marked unknown.
   /// \param dest: object map to update
   /// \param src: expression to add
@@ -205,7 +205,7 @@ class value_sett
   }
 
   /// Adds a numbered expression and offset to an object map. If the
-  /// destination map has an existing entry for the same expression
+  /// destination map has an existing element for the same expression
   /// with a differing offset its offset is marked unknown.
   /// \param dest: object map to update
   /// \param n: object number to add; must be mapped to the corresponding
@@ -217,7 +217,7 @@ class value_sett
     const offsett &offset) const;
 
   /// Adds an expression and offset to an object map. If the
-  /// destination map has an existing entry for the same expression
+  /// destination map has an existing element for the same expression
   /// with a differing offset its offset is marked unknown.
   /// \param dest: object map to update
   /// \param expr: expression to add
@@ -230,7 +230,7 @@ class value_sett
   /// Represents a row of a `value_sett`. For example, this might represent
   /// `dynamic_object1.field1 -> { <dynamic_object2, 0> }`, with
   /// `identifier == dynamic_object1`, `suffix` == `.field1` and
-  /// a single-entry `object_map` representing `{ <dynamic_object2, 0> }`.
+  /// a single-element `object_map` representing `{ <dynamic_object2, 0> }`.
   struct entryt
   {
     object_mapt object_map;