Improve documentation of LFUN_BUFFER_ZOOM_{IN,OUT}

The default for ZOOM_OUT is -20 from a user perspective. That is,
the following are equivalent:

  buffer-zoom-out -20
  buffer-zoom-out

The reason for this is that the argument to ZOOM_OUT is treated the
exact same way as ZOOM_IN. The only way they differ is how the
default case is handled.

This commit also clarifies that (1) the argument may be positive or
negative and that (2) the argument is interpreted as percentage
points, not percent.
This commit is contained in:
Scott Kostyshak 2016-07-19 02:11:27 -04:00
parent d158bca200
commit 3826ff6434
2 changed files with 4 additions and 4 deletions

View File

@ -5908,7 +5908,7 @@ Syntax buffer-zoom-in [<ZOOM>]
\end_layout
\begin_layout Description
Params <ZOOM>: The zoom in %, the default is 20.
Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
\end_layout
\begin_layout Description
@ -5928,7 +5928,7 @@ Syntax buffer-zoom-out [<ZOOM>]
\end_layout
\begin_layout Description
Params <ZOOM>: The zoom in %, the default is 20.
Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
\end_layout
\begin_layout Description

View File

@ -3739,7 +3739,7 @@ void LyXAction::init()
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
* \li Action: Increases the zoom of the screen fonts.
* \li Syntax: buffer-zoom-in [<ZOOM>]
* \li Params: <ZOOM>: The zoom in %, the default is 20.
* \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
* \li Origin: vfr, 30 Mar 2009
* \endvar
*/
@ -3749,7 +3749,7 @@ void LyXAction::init()
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
* \li Action: Decreases the zoom of the screen fonts.
* \li Syntax: buffer-zoom-out [<ZOOM>]
* \li Params: <ZOOM>: The zoom in %, the default is 20.
* \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
* \li Origin: vfr, 30 Mar 2009
* \endvar
*/