#9477 add documentation for optional language argument of LFUN_SPELLING_{ADD,REMOVE,IGNORE}

This commit is contained in:
Stephan Witt 2015-03-28 09:24:08 +01:00
parent 83f8909a57
commit 7789f3eb37

View File

@ -1025,6 +1025,7 @@ void LyXAction::init()
* \var lyx::FuncCode lyx::LFUN_SPELLING_ADD * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
* \li Action: Add the word under the cursor to the respective * \li Action: Add the word under the cursor to the respective
* spell checker dictionary. * spell checker dictionary.
* The default for the language is retrieved from the cursor position.
* \li Syntax: spelling-add [<STRING>] [<LANG>] * \li Syntax: spelling-add [<STRING>] [<LANG>]
* \li Params: <WORD>: word to add * \li Params: <WORD>: word to add
<LANG>: language name (see file languages) <LANG>: language name (see file languages)
@ -1036,6 +1037,7 @@ void LyXAction::init()
* \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
* \li Action: Let the spell checker ignore the word under the cursor * \li Action: Let the spell checker ignore the word under the cursor
* in the current session for the given language. * in the current session for the given language.
* The default for the language is retrieved from the cursor position.
* \li Syntax: spelling-ignore [<WORD>] [<LANG>] * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
* \li Params: <WORD>: word to ignore * \li Params: <WORD>: word to ignore
<LANG>: language name (see file languages) <LANG>: language name (see file languages)
@ -1047,9 +1049,10 @@ void LyXAction::init()
* \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
* \li Action: Remove the word under the cursor from the respective * \li Action: Remove the word under the cursor from the respective
* spell checker dictionary. * spell checker dictionary.
* The default for the language is retrieved from the cursor position.
* \li Syntax: spelling-remove [<STRING>] [<LANG>] * \li Syntax: spelling-remove [<STRING>] [<LANG>]
* \li Params: <WORD>: word to remove * \li Params: <WORD>: word to remove
<LANG>: language name (see file languages) * <LANG>: language name (see file languages)
* \li Origin: SWitt, 28 July 2010 * \li Origin: SWitt, 28 July 2010
* \endvar * \endvar
*/ */