Fix bug 886 and others not reported related with the document paper size.

[lyx.git] / src / FuncStatus.h

diff --git a/src/FuncStatus.h b/src/FuncStatus.h
index 3f5d7b14c1293de2ae12af30751c849c96783568..054b7db81849ff565dbb36f1d237984aea58b4fa 100644 (file)
--- a/src/FuncStatus.h
+++ b/src/FuncStatus.h
@@ -21,15 +21,21 @@ class FuncStatus
 private:
 
        enum StatusCodes {
-               ///
+               /// Command can be executed
                OK = 0,
-               ///
+               /// This command does not exist, possibly because it is not
+               /// compiled in (e.g. LFUN_THESAURUS) or the user mistyped
+               /// it in the minibuffer. UNKNOWN commands have no menu entry.
                UNKNOWN = 1,
-               ///
-               DISABLED = 2,  // Command cannot be executed
-               ///
+               /// Command cannot be executed
+               DISABLED = 2,
+               /// Command is on (i. e. the menu item has a checkmark
+               /// and the toolbar icon is pushed).
+               /// Not all commands use this
                ON = 4,
-               ///
+               /// Command is off (i. e. the menu item has no checkmark
+               /// and the toolbar icon is not pushed).
+               /// Not all commands use this
                OFF = 8
        };
 
@@ -51,12 +57,13 @@ public:
 
        ///
        void enabled(bool b);
-       ///
+       /// tells whether it can be invoked (otherwise it will be grayed-out).
        bool enabled() const;
 
        ///
        void setOnOff(bool b);
-       ///
+       /// tells whether the menu item should have a check mark
+       /// (or the toolbar icon should be pushed).
        bool onoff(bool b) const;
 
        ///