* Comment ( http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg139671.html ).

[lyx.git] / src / support / docstring.h

diff --git a/src/support/docstring.h b/src/support/docstring.h
index e84ba6f2d0c84a5e4443e249efd8375b67d6f248..a98bbaa71bf038cafca27b6dbd42ea8f0dd8b0a6 100644 (file)
--- a/src/support/docstring.h
+++ b/src/support/docstring.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Georg Baum
  *
  * Full author contact details are available in file CREDITS.
@@ -19,7 +19,11 @@
 
 namespace lyx {
 
-/// String type for storing the main text in UCS4 encoding
+/**
+ * String type for storing the main text in UCS4 encoding.
+ * Use std::string only in cases 7-bit ASCII is to be manipulated
+ * within the variable.
+ */
 typedef std::basic_string<char_type> docstring;
 
 /// Creates a docstring from a C string of ASCII characters