Document new behavior of "delete" LFUNs

[features.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 9171e1c8b831cc08345ac320f08e8d1616a74f11..5223d4a0d075cff269216328fab470dafde92932 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -574,7 +574,7 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
  * \li Action: Exports the current buffer (document) to the given format.
- * \li Syntax: buffer-export <FORMAT> [<DEST>]
+ * \li Syntax: buffer-export [<FORMAT>] [<DEST>]
  * \li Params: <FORMAT> is either "custom" or one of the formats which you
                         can find in Tools->Preferences->File formats->Format.
                         Usual format you will enter is "pdf2" (pdflatex),
@@ -582,7 +582,9 @@ void LyXAction::init()
                         In case of "custom" you will be asked for a format you
                         want to start from and for the command that you want to
                         apply to this format. Internally the control is then passed
-                        to #LFUN_BUFFER_EXPORT_CUSTOM.
+                        to #LFUN_BUFFER_EXPORT_CUSTOM.\n
+                        If absent or "default", then the default output format of the
+                        document is used.
                <DEST>  If present, this argument provides the export destination
                        filename. Its containing folder will also be the destination
                        folder, where all the needed external files will be copied.
@@ -876,6 +878,16 @@ void LyXAction::init()
  */
                { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR
+ * \li Action: Clear the external modification flag on the current buffer.
+ * \li Syntax: buffer-external-modification-clear
+ * \li Origin: gm, 2 March 2017
+ * \endvar
+ */
+               { LFUN_BUFFER_EXTERNAL_MODIFICATION_CLEAR,
+                 "buffer-external-modification-clear", ReadOnly, Buffer },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
  * \li Action: Increases the zoom of the screen fonts.
@@ -1080,7 +1092,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
  * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
- * \li Syntax: char-delete-backward
+ * \li Syntax: char-delete-backward [force]
+ * \li Params: force: Delete big insets, do not only select them.
  * \endvar
  */
                { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
@@ -1088,7 +1101,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
  * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
- * \li Syntax: char-delete-forward
+ * \li Syntax: char-delete-forward [force]
+ * \li Params: force: Delete big insets, do not only select them.
  * \endvar
  */
                { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
@@ -1735,6 +1749,15 @@ void LyXAction::init()
  */
                { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_FONT_CROSSOUT
+ * \li Action: Toggles xout (cross-through) in the font (selection-wise).
+ * \li Syntax: font-crossout
+ * \li Origin: uwestoehr, 4 April 2017
+ * \endvar
+ */
+               { LFUN_FONT_CROSSOUT, "font-crossout", Noop, Layout },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
  * \li Action: Toggles the typewriter family font (selection-wise).
@@ -2008,7 +2031,7 @@ void LyXAction::init()
                matches all note insets, while "Note:Note" only matches LyX
                yellow note insets.
  * \li Sample: Remove all index insets: \n
-                  inset-forall Index char-delete-forward \n
+                  inset-forall Index char-delete-forward force \n
                Close all Notes (also works for a particular branch, for example): \n
                   inset-forall Note inset-toggle close \n
                Transform all yellow notes to comments \n
@@ -3248,6 +3271,7 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_REPEAT
  * \li Action: Repeat the given command.
+ * \li Notion: fails when the repeat count is greater than 10000.
  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
  * \li Origin: Andre, 27 Oct 2003
  * \endvar
@@ -4007,7 +4031,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
  * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
- * \li Syntax: word-delete-backward
+ * \li Syntax: word-delete-backward [force]
+ * \li Params: force: Delete big insets, do not only select them.
  * \endvar
  */
                { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
@@ -4015,7 +4040,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
  * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
- * \li Syntax: word-delete-forward
+ * \li Syntax: word-delete-forward [force]
+ * \li Params: force: Delete big insets, do not only select them.
  * \endvar
  */
                { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },