Clarify some comments.

[lyx.git] / src / LyXAction.h

diff --git a/src/LyXAction.h b/src/LyXAction.h
index 6d0e8228e7ba38415d769e9674d1fdd7c672a4ee..2f718ff722edfa3971ec7e2f8bf2d20a030e4378 100644 (file)
--- a/src/LyXAction.h
+++ b/src/LyXAction.h
@@ -93,13 +93,13 @@ public:
        bool funcHasFlag(FuncCode action, FuncAttribs flag) const;
 
        /// iterator across all real actions
-       typedef FuncMap::const_iterator const_func_iterator;
+       typedef FuncMap::const_iterator const_iterator;
 
        /// return an iterator to the start of all real actions
-       const_func_iterator func_begin() const;
+       const_iterator func_begin() const;
 
        /// return an iterator to the end of all real actions
-       const_func_iterator func_end() const;
+       const_iterator func_end() const;
 
 private:
        /// populate the action container with our actions
@@ -108,16 +108,19 @@ private:
        void newFunc(FuncCode, std::string const & name, unsigned int attrib, FuncType type);
 
        /**
-        * This is a list of all the LyXFunc names with the
-        * coresponding action number. It is usually only used by the
-        * minibuffer or when assigning commands to keys during init.
+        * This maps LyX function names to function codes, e.g.:
+        *   lyx_func_map["ert-insert"] == LFUN_ERT_INSERT
         */
        FuncMap lyx_func_map;
 
        /**
-        * This is a mapping from action number to an object holding
-        * info about this action. f.ex. command name (string),
-        * command attributes (ro)
+        * This maps function codes to objects holding info about the corresponding
+        * action. E.g., if
+        *   FuncInfo const & ert = lyx_info_map[LFUN_ERT_INSERT];
+        * then:
+        *   ert.name   == "ert-insert"'
+        *   ert.attrib == Noop
+        *   ert.type   == Edit
         */
        InfoMap lyx_info_map;
 };