Fix bug http://bugzilla.lyx.org/show_bug.cgi?id=4599

[lyx.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 95b78060386ea287eb8ddeecb819398cb22fca46..b0f04cc7844d21d9ed389e84231c97828904842f 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -983,9 +983,48 @@ void LyXAction::init()
                { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
                { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
 
+/*!
+ * \var lyx::kb_action lyx::LFUN_INSET_APPLY
+ * \li Action: Apply data for an inset.
+ * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
+               be applied. This is either changed to #LFUN_INSET_MODIFY or
+               #LFUN_INSET_INSERT depending on the context where it is called.
+ * \li Syntax: inset-apply <ARGS>
+ * \li Params: See #LFUN_INSET_INSERT .
+ * \endvar
+ */
                { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
                { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
+/*!
+ * \var lyx::kb_action lyx::LFUN_INSET_INSERT
+ * \li Action: Insert new inset (type given by the parameters).
+ * \li Syntax: inset-insert <INSET> <ARGS>
+ * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
+                         hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
+               <ARGS>: depends on the given inset. Use "lyx -dbg action" to
+                      explore.
+ * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
+               where <label name> is the name of the referenced label and
+              <Format> is one of the following: \n
+              ref -- <reference> \n
+              eqref -- (<reference>) \n
+              pageref -- <page> \n
+               vpageref -- on <page> \n
+              vref -- <reference> on <page> \n
+               prettyref -- Formatted reference
+ * \endvar
+ */
                { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
+/*!
+ * \var lyx::kb_action lyx::LFUN_INSET_MODIFY
+ * \li Action: Modify existing inset.
+ * \li Notion: Used for label, floats, listings, box, branch, external, wrap
+               bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
+              inlude, ref insets.
+ * \li Syntax: inset-modify <INSET> <ARGS>
+ * \li Params: See #LFUN_INSET_INSERT for further details.
+ * \endvar
+ */
                { LFUN_INSET_MODIFY, "", Noop, Hidden },
                { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
                { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
@@ -1344,8 +1383,31 @@ void LyXAction::init()
                { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
                { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
 
+/*!
+ * \var lyx::kb_action lyx::LFUN_FILE_INSERT
+ * \li Action: Inserts another LyX file.
+ * \li Syntax: file-insert [<FILE>]
+ * \li Params: <FILE>: Filename to be inserted.
+ * \endvar
+ */
                { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
+/*!
+ * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT
+ * \li Action: Inserts plain text file.
+ * \li Syntax: file-insert-plaintext [<FILE>]
+ * \li Params: <FILE>: Filename to be inserted.
+ * \li Origin: CFO-G, 19 Nov 1997
+ * \endvar
+ */
                { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
+/*!
+ * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
+ * \li Action: Inserts plain text file as paragraph (i.e. join lines).
+ * \li Syntax: file-insert-plaintext-para [<FILE>]
+ * \li Params: <FILE>: Filename to be inserted.
+ * \li Origin: Levon, 14 Feb 2001
+ * \endvar
+ */
                { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
 /*!
  * \var lyx::kb_action lyx::LFUN_FILE_OPEN