- /// Appends a possibly abbreviated representation of our text
- /// to \param os, where \param maxlen defines the maximum size
- /// of \param os. If \param shorten is true, then we will shorten
- /// \param os to maxlen chars and replace the final three by "...,
- /// if \param os is longer than maxlen chars.
- /// if \param maxlen is passed as 0, then it is ignored. (In fact,
- /// it is reset to the maximum value for size_t.)
+
+ /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
+ /// and '\t' with spaces
+ static void shortenForOutliner(docstring & str, size_t const maxlen);
+
+ /// Appends a possibly abbreviated representation of our text to \param os,
+ /// where \param maxlen defines the maximum size of \param os. If \param
+ /// shorten is true, then os is shortened as above.