Improve documentation of inset-(begin|end)(|-select)

[features.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 958ef894fcc13709444bd3b4501740b96b14a587..771a7e5c542e8abd9a4088a0de2b2489a3dcedad 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -742,7 +742,8 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
  * \li Action: Reverts opened document.
- * \li Syntax: buffer-reload
+ * \li Syntax: buffer-reload [dump]
+ * \li Params: dump: do not ask for any confirmation, just reload. All changes will be lost.
  * \li Origin: Asger, 2 Feb 1997
  * \endvar
  */
@@ -1853,15 +1854,6 @@ void LyXAction::init()
  */
                { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
 
-/*!
- * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
- * \li Action: Reloads the image if necessary.
- * \li Syntax: graphics-reload
- * \li Origin: vfr, 10 Aug 2009
- * \endvar
- */
-               { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
-
 /*!
  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
  * \li Action: Open the given help file according to the language setting.
@@ -1959,8 +1951,10 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
  * \li Action: Move the cursor to the beginning of the current inset
-               if it is not already there, or at the beginning of the
-               enclosing inset otherwise
+               if it is not already there. If the cursor is already at
+               the beginning of the current inset, move it to the
+               beginning of the enclosing inset or the main work area,
+               respectively, if there is no enclosing inset.
  * \li Syntax: inset-begin
  * \li Origin: lasgouttes, 16 Mar 2009
  * \endvar
@@ -1970,8 +1964,10 @@ void LyXAction::init()
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
  * \li Action: Move the cursor to the beginning of the current inset
-               if it is not already there, or at the beginning of the
-               enclosing inset otherwise (adding the
+               if it is not already there. If the cursor is already at
+               the beginning of the current inset, move it to the
+               beginning of the enclosing inset or the main work area,
+               respectively, if there is no enclosing inset (adding the
                traversed text to the selection).
  * \li Syntax: inset-begin-select
  * \li Origin: lasgouttes, 16 Mar 2009
@@ -2030,9 +2026,11 @@ void LyXAction::init()
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_END
- * \li Action: Move the cursor to the end of the current inset
-               if it is not already there, or at the end of the
-               enclosing inset otherwise
+ * \li Action: Move the cursor to the end of the current inset if it
+               is not already there. If the cursor is already at the
+               end of the current inset, move it to the end of the
+               enclosing inset or the main work area, respectively, if
+               there is no enclosing inset.
  * \li Syntax: inset-end
  * \li Origin: lasgouttes, 16 Mar 2009
  * \endvar
@@ -2041,9 +2039,11 @@ void LyXAction::init()
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
- * \li Action: Move the cursor to the end of the current inset
-               if it is not already there, or at the end of the
-               enclosing inset otherwise (adding the
+ * \li Action: Move the cursor to the end of the current inset if it
+               is not already there. If the cursor is already at the
+               end of the current inset, move it to the end of the
+               enclosing inset or the main work area, respectively, if
+               there is no enclosing inset (adding the
                traversed text to the selection).
  * \li Syntax: inset-end-select
  * \li Origin: lasgouttes, 16 Mar 2009
@@ -3544,16 +3544,35 @@ void LyXAction::init()
                { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
 
 /*!
- * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_SET_GROUP
  * \li Action: Set the group for the graphics inset on the cursor position.
- * \li Syntax: set-graphics-group [<GROUP>]
+ * \li Syntax: graphics-set-group [<GROUP>]
  * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
                         the graphics inset is removed from the current group.
  * \li Origin: sanda, 6 May 2008
  * \endvar
  */
-               { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
+               { LFUN_GRAPHICS_SET_GROUP, "graphics-set-group", Noop, Edit },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_UNIFY
+ * \li Action: Set the same group for all graphics insets in the marked block.
+ * \li Syntax: graphics-unify [<GROUP>]
+ * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
+                        the group Id from the first graphics inset will be used.
+ * \li Origin: sanda, 7 Feb 2018
+ * \endvar
+ */
+               { LFUN_GRAPHICS_UNIFY, "graphics-unify", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
+ * \li Action: Reloads the image if necessary.
+ * \li Syntax: graphics-reload
+ * \li Origin: vfr, 10 Aug 2009
+ * \endvar
+ */
+               { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
 
 /*!
  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
@@ -4210,14 +4229,24 @@ void LyXAction::init()
  * \li Action: Replace a string in the document.
  * \li Syntax: word-replace [<DATA>]
  * \li Params: <DATA>: data is of the form
-                       "<replace> \n
-                        <search> \n
+                       "<replacestring> \n
+                        <searchstring> \n
                         <casesensitive> <matchword> <all> <forward> <findnext>"
  * \li Origin: Andre, Jan 7 2004
  * \endvar
  */
                { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_ANONYMIZE
+ * \li Action: For debug purposes only. Convert all [a-zA-Z0-1] characters to
+               single character. Useful when submitting docs to list or bugzilla.
+ * \li Syntax: buffer-anonymize
+ * \li Origin: sanda, Feb 1 2018
+ * \endvar
+ */
+               { LFUN_BUFFER_ANONYMIZE, "buffer-anonymize", Noop, Edit },
+
 /*!
  * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
  * \li Action: Moves the cursor to the next beginning of a word "on the right".