Updates requested in the review.

Author: marek-trtik

src/taint-slicer/instrumenter.cpp

@@ -43,11 +43,17 @@ static std::string generate_fresh_automaton_variable_for_token(
 /// The function is responsible for updating structure initialiser
 /// instruction of an ASSIGN instruction, i.e. the rhs of the instruction,
 /// according to new (instrumented) type of the lhs of the assignement.
+/// \param initialiser: The original structure initialiser whose instrumented
+///   version is computed
+/// \param fixed_type: Updated type of assignment's LHS which we will use as
+///   a guide for instrumentation of the original initialiser.
+/// \param props: Data computed in the previous step (before the instrumenter)
+///   required here to know what to instrument and where.
 exprt taint_instrumentert::
   add_shadow_variables_to_structure_initializer(
-  const exprt &initialiser,   ///< The original structure initialiser
-  const struct_typet &fixed_type,   ///< Updated type of assignment's LHS
-  const taint_instrumentation_propst &props /**< doxylinter be silent */) const
+  const exprt &initialiser,
+  const struct_typet &fixed_type,
+  const taint_instrumentation_propst &props) const
 {
   const namespacet ns(get_instrumented_symbol_table());
   struct_exprt fixed_initialiser(fixed_type);
@@ -98,15 +104,17 @@ void taint_instrumentert::instrument_instructions_with_shadow_variables(
   const taint_instrumentation_propst &props) const
 {
   const namespacet ns(get_instrumented_symbol_table());
-  for(auto &I : instructions_to_be_instrumented)
+  for(auto &instr : instructions_to_be_instrumented)
   {
-    switch(I.type)
+    switch(instr.type)
     {
     case ASSIGN:
       {
-        code_assignt &asgn=to_code_assign(I.code);
+        code_assignt &asgn=to_code_assign(instr.code);
         if(asgn.rhs().id()==ID_struct)
         {
+          // Here we handle assignments where RHS is a structure initialiser,
+          // e.g. *x={.data=null,.length=10,...}.
           asgn.rhs()=
             add_shadow_variables_to_structure_initializer(
               asgn.rhs(),
@@ -218,7 +226,7 @@ void taint_instrumentert::run()
   std::map<
     taint_instrumentation_propst::location_props_idt,
     taint_mutable_instruction_idt> instrumented_locations;
-  for(std::vector<taint_instrumentation_propst::location_propst>::size_type
+  for(taint_instrumentation_propst::location_props_idt
       lid=0UL, end=props.get_location_props().size();
       lid!=end;
       ++lid)