Format comments correctly

Author: Owen Jones

src/goto-instrument/accelerate/util.cpp

@@ -48,9 +48,7 @@ bool is_signed(const typet &t)
 }
 
 
-/**
- * Convenience function -- is the type unsigned?
- */
+/// Convenience function -- is the type unsigned?
 bool is_unsigned(const typet &t)
 {
   return t.id()==ID_bv ||

src/goto-instrument/wmm/event_graph.h

@@ -97,9 +97,8 @@ class event_grapht
        from.hide_internals(&target) */
     void hide_internals(critical_cyclet &reduced) const;
 
-    /* checks whether there is at least one pair which is unsafe
-       (takes fences and dependencies into account), and adds
-       the unsafe pairs in the set */
+    /// checks whether there is at least one pair which is unsafe (takes fences
+    /// and dependencies into account), and adds the unsafe pairs in the set
     bool is_unsafe(memory_modelt model, bool fast=false);
 
     /* do not update the unsafe pairs set */

src/goto-instrument/wmm/goto2graph.h

@@ -258,18 +258,18 @@ class instrumentert
       }
     }
 
-    // TODO: move the visitor outside, and inherit
+    /// TODO: move the visitor outside, and inherit
     virtual void visit_cfg_function(
-      /* value_sets and options */
+      /// value_sets and options
       value_setst &value_sets,
       memory_modelt model,
       bool no_dependencies,
       loop_strategyt duplicate_body,
-      /* function to analyse */
+      /// function to analyse
       const irep_idt &function,
-      /* incoming edges */
+      /// incoming edges
       const std::set<nodet> &initial_vertex,
-      /* outcoming edges */
+      /// outcoming edges
       std::set<nodet> &ending_vertex);
 
     bool inline local(const irep_idt &i);

src/musketeer/fence_inserter.h

@@ -64,7 +64,7 @@ class fence_insertert
 
   instrumentert &instrumenter;
 
-  /* normal variables used almost every time */
+  /// normal variables used almost every time
   std::map<unsigned, edget> &map_to_e;
   std::map<edget, unsigned> &map_from_e;
   unsigned add_edge(const edget &e) { return var.add_edge(e); }
@@ -73,11 +73,11 @@ class fence_insertert
     return invisible_var.add_edge(e);
   }
 
-  /* number of constraints */
+  /// number of constraints
   std::size_t constraints_number;
   const memory_modelt model;
 
-  /* to retrieve the concrete graph edges involved in the (abstract) cycles */
+  /// to retrieve the concrete graph edges involved in the (abstract) cycles
   const_graph_visitort const_graph_visitor;
 
 protected:

src/musketeer/graph_visitor.cpp

@@ -346,7 +346,7 @@ void const_graph_visitort::PT(
 #ifdef BTWN1
     event_grapht &egraph=fence_inserter.instrumenter.egraph;
 
-    /* all the pos in between */
+    /// all the pos in between
     for(wmm_grapht::edgest::const_iterator
       next_it=egraph.po_out(e.first).begin();
       next_it!=egraph.po_out(e.first).end();

src/util/expr_util.h

@@ -28,28 +28,28 @@ class symbolt;
 class typet;
 class namespacet;
 
-/*! \deprecated This function will eventually be removed. Use functions from
- * \ref util/std_expr.h instead.
-*/
+/// \deprecated This function will eventually be removed. Use functions
+/// from \ref util/std_expr.h instead.
+
 void make_next_state(exprt &);
 
-/*! splits an expression with >=3 operands into nested binary expressions */
+/// splits an expression with >=3 operands into nested binary expressions
 exprt make_binary(const exprt &);
 
-/*! converts an update expr into a (possibly nested) with expression */
+/// converts an update expr into a (possibly nested) with expression
 with_exprt make_with_expr(const update_exprt &);
 
-/*! converts a scalar/float expression to C/C++ Booleans */
+/// converts a scalar/float expression to C/C++ Booleans
 exprt is_not_zero(const exprt &, const namespacet &ns);
 
-/*! negate a Boolean expression, possibly removing a not_exprt,
-    and swapping false and true */
+/// negate a Boolean expression, possibly removing a not_exprt,
+/// and swapping false and true
 exprt boolean_negate(const exprt &);
 
-/*! returns true if the expression has a subexpression with given ID */
+/// returns true if the expression has a subexpression with given ID
 bool has_subexpr(const exprt &, const irep_idt &);
 
-/*! lift up an if_exprt one level */
+/// lift up an if_exprt one level
 if_exprt lift_if(const exprt &, std::size_t operand_number);
 
 #endif // CPROVER_UTIL_EXPR_UTIL_H