* Doxy.

[lyx.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index f35f3c39d76800e9017918459504944a6be3b66e..5fe8245ed618e53eaf0bcb70011fd7dc084a74e7 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -498,15 +498,44 @@ void LyXAction::init()
  */
                { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
+ * \li Action: Inserts Nomenclature entry.
+ * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
+ * \li Syntax: nomencl-insert [<SYMBOL>]
+ * \li Origin: Ugras, 4 Nov 2006
+ * \endvar
+ */
                { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
+ * \li Action: Inserts list of Nomenclature entries.
+ * \li Syntax: nomenclature-print
+ * \li Origin: Ugras, 4 Nov 2006
+ * \endvar
+ */
                { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
+ * \li Action: Inserts Note on the current cursor postion,
+               move selection inside the inset.
+ * \li Syntax: note-insert [<TYPE>]
+ * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
+ * \endvar
+ */
                { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
+ * \li Action: Moves the cursor to the begining of next Note inset.
+ * \li Syntax: note-next
+ * \endvar
+ */
                { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
  * \li Action: Inserts a line break or new line.
- * \li Syntax: newline-insert <ARG>
+ * \li Syntax: newline-insert [<ARG>]
  * \li Params: <ARG>: <newline|linebreak> default: newline
  * \li Origin: JSpitzm, 25 Mar 2008
  * \endvar
@@ -887,16 +916,75 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
+ * \li Action: Move the cursor to the beginning of the document.
+ * \li Syntax: buffer-begin
+ * \endvar
+ */
                { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
+ * \li Action: Move the cursor to the beginning of the document adding the
+               traversed text to the selection.
+ * \li Syntax: buffer-begin-select
+ * \endvar
+ */
                { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_END
+ * \li Action: Move the cursor to the end of the document.
+ * \li Syntax: buffer-end
+ * \endvar
+ */
                { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
+ * \li Action: Move the cursor to the end of the document adding the
+               traversed text to the selection.
+ * \li Syntax: buffer-end-select
+ * \endvar
+ */
                { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
+ * \li Action: Move the cursor to the begining of the (screen) line.
+ * \li Syntax: line-begin
+ * \endvar
+ */
                { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
+ * \li Action: Move the cursor to the beginning of the (screen) line adding the
+               traversed text to the selection.
+ * \li Syntax: line-begin-select
+ * \endvar
+ */
                { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
-               { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_END
+ * \li Action: Move the cursor to the end of the (screen) line.
+ * \li Syntax: line-end
+ * \endvar
+ */
                { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
+ * \li Action: Move the cursor to the end of the (screen) line adding the
+               traversed text to the selection.
+ * \li Syntax: line-end-select
+ * \endvar
+ */
                { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
+ * \li Action: Deletes the letters to the end of the (screen) line or
+               deletes the selection.
+ * \li Syntax: line-delete-forward
+ * \endvar
+ */
+               { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 /*!
  * \var lyx::FuncCode lyx::LFUN_COPY
  * \li Action: Copies to the clipboard the last edit.
@@ -957,7 +1045,21 @@ void LyXAction::init()
  */
                { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
+ * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
+               inside lists.
+ * \li Syntax: depth-decrement
+ * \endvar
+ */
                { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
+ * \li Action: Increase the nesting depth of the (selected) paragraph(s)
+               inside lists.
+ * \li Syntax: depth-increment
+ * \endvar
+ */
                { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
                { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },