Update other comment.

[lyx.git] / src / Paragraph.h

diff --git a/src/Paragraph.h b/src/Paragraph.h
index 97d36dc443b659667b28a076281ef0ba584ffe8f..587612d76b3c5a7f64711ed55cba79648e8fbe25 100644 (file)
--- a/src/Paragraph.h
+++ b/src/Paragraph.h
@@ -128,7 +128,7 @@ enum AsStringParameter
        AS_STR_INSETS = 2, ///< Go into insets.
        AS_STR_NEWLINES = 4, ///< Get also newline characters.
        AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
-       AS_STR_PLAINTEXT = 16 ///< Extract only the explicitly visible text (without any formatting), when descending into insets
+       AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
 };
 
 
@@ -174,12 +174,14 @@ public:
        ///             asString(AS_STR_LABEL | AS_STR_INSETS)
        ///             asString(AS_STR_INSETS)
        docstring asString(int options = AS_STR_NONE) const;
-       ///
+
+       /// Convert the paragraph to a string.
+       /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
        docstring asString(pos_type beg, pos_type end,
                           int options = AS_STR_NONE,
-                          const OutputParams *p_runparams = 0) const;
+                          const OutputParams *runparams = 0) const;
        ///
-       void forToc(docstring &, size_t maxlen) const;
+       void forOutliner(docstring &, size_t maxlen) const;
 
        ///
        void write(std::ostream &, BufferParams const &,