* src/text3.C (doDispatch):

[lyx.git] / src / bufferparams.h

diff --git a/src/bufferparams.h b/src/bufferparams.h
index 578645f3ee4488e4ec92a5588745f7f0a6e7816f..99d40077652b3ca94e49323c9f0c8a7ecc3e1a65 100644 (file)
--- a/src/bufferparams.h
+++ b/src/bufferparams.h
@@ -31,6 +31,7 @@ namespace lyx {
 class AuthorList;
 class BranchList;
 class Bullet;
+class Encoding;
 class LyXLex;
 class LatexFeatures;
 class Spacing;
@@ -177,14 +178,23 @@ public:
        BranchList const & branchlist() const;
        /**
         * The input encoding for LaTeX. This can be one of
-        * - auto: find out the input encoding from the used languages
-        * - default: Don't load the inputenc package and hope that it will
-        *   work (unlikely)
+        * - \c auto: find out the input encoding from the used languages
+        * - \c default: ditto
         * - any encoding supported by the inputenc package
         * The encoding of the LyX file is always utf8 and has nothing to
         * do with this setting.
+        * The difference between \c auto and \c default is that \c auto also
+        * causes loading of the inputenc package, while \c default does not.
+        * \c default will not work unless the user takes additional measures
+        * (such as using special environments like the CJK environment from
+        * CJK.sty).
+        * \c default can be seen as an unspecified 8bit encoding, since LyX
+        * does not interpret it in any way apart from display on screen.
         */
        std::string inputenc;
+       /// The main encoding used by this buffer for LaTeX output.
+       /// Individual pieces of text can use different encodings.
+       Encoding const & encoding() const;
        ///
        std::string preamble;
        ///