Move documentation of try_get_string_data_array() to header file

Author: danpoe

src/util/simplify_expr.cpp

@@ -1656,18 +1656,6 @@ optionalt<std::string> simplify_exprt::expr2bits(
   return {};
 }
 
-/// Get char sequence from refined string expression
-///
-/// If `s.content()` is of the form `&id[e]`, where `id` is an array-typed
-/// symbol expression (and `e` is any expression), return the value of the
-/// symbol `id` (as given by the `value` field of the symbol in the namespace
-/// `ns`); otherwise return an empty optional.
-///
-/// \param s: refined string expression
-/// \param ns: namespace
-/// \return array expression representing the char sequence which forms the
-///   content of the refined string expression, empty optional if the content
-///   cannot be determined
 optionalt<std::reference_wrapper<const array_exprt>>
 try_get_string_data_array(const refined_string_exprt &s, const namespacet &ns)
 {

src/util/simplify_expr.h

@@ -31,6 +31,18 @@ bool simplify(
 // this is the preferred interface
 exprt simplify_expr(exprt src, const namespacet &ns);
 
+/// Get char sequence from refined string expression
+///
+/// If `s.content()` is of the form `&id[e]`, where `id` is an array-typed
+/// symbol expression (and `e` is any expression), return the value of the
+/// symbol `id` (as given by the `value` field of the symbol in the namespace
+/// `ns`); otherwise return an empty optional.
+///
+/// \param s: refined string expression
+/// \param ns: namespace
+/// \return array expression representing the char sequence which forms the
+///   content of the refined string expression, empty optional if the content
+///   cannot be determined
 optionalt<std::reference_wrapper<const array_exprt>>
 try_get_string_data_array(const refined_string_exprt &s, const namespacet &ns);