rename LFUNs math-nonumber and math-number to what they really do,

[lyx.git] / src / lfuns.h

diff --git a/src/lfuns.h b/src/lfuns.h
index e5c85146965eb75a01213f22363834bfb0d1419c..fdf5f2219ba18a8368d0dcd2993276b18e7f226b 100644 (file)
--- a/src/lfuns.h
+++ b/src/lfuns.h
@@ -273,21 +273,21 @@ enum kb_action {
        LFUN_MATH_DISPLAY,              // Alejandro 180696
        LFUN_MATH_MODE,                 // Alejandro 040696
 /**
- * LFUN_MATH_NUMBER
- * \li Action: Enable numbering of the current formula.
+ * LFUN_MATH_NUMBER_TOGGLE
+ * \li Action: Toggles numbering of the current formula.
  * \li Notion: Must be in display formula mode.
- * \li Syntax: math-number
+ * \li Syntax: math-number-toggle
  * \li Origin: Alejandro 4 Jun 1996
  */
-       LFUN_MATH_NUMBER,
+       LFUN_MATH_NUMBER_TOGGLE,
 /**
- * LFUN_MATH_NONUMBER
- * \li Action: Disable numbering of the current formula.
+ * LFUN_MATH_NUMBER_LINE_TOGGLE
+ * \li Action: Toggles numbering of the current formula line.
  * \li Notion: Must be in display formula mode.
- * \li Syntax: math-nonumber
+ * \li Syntax: math-number-line-toggle
  * \li Origin: Alejandro 18 Jun 1996
  */
-       LFUN_MATH_NONUMBER,
+       LFUN_MATH_NUMBER_LINE_TOGGLE,
        LFUN_MATH_SIZE,                 // Alejandro 150896
        // 110
        LFUN_MATH_MACRO,                // ale970510
@@ -315,7 +315,7 @@ enum kb_action {
        // 120
  /**
  * LFUN_LAYOUT
- * \li Action: Sets the layout for the current paragraph
+ * \li Action: Sets the layout (that is, environment) for the current paragraph
  * \li Syntax: layout <LAYOUT>
  * \li Params: <LAYOUT>: the layout to use
  */
@@ -370,7 +370,13 @@ enum kb_action {
        LFUN_DELETE_FORWARD_SKIP,
        LFUN_BUFFER_NEW_TEMPLATE,       // Asger 1997-02-02
        LFUN_BUFFER_RELOAD,             // Asger 1997-02-02
-       LFUN_RECONFIGURE,               // Asger 1997-02-14
+/**
+ * LFUN_RECONFIGURE
+ * \li Action: Reconfigure the automatic settings.
+ * \li Syntax: reconfigure
+ * \li Origin: Asger, 14 Feb 1997
+ */
+       LFUN_RECONFIGURE,
        LFUN_INDEX_PRINT,               // Lgb 97-02-27
        // 155
        LFUN_CELL_SPLIT,
@@ -397,7 +403,13 @@ enum kb_action {
        LFUN_BUFFER_IMPORT,             // Asger 980724
        LFUN_COMMAND_SEQUENCE,          // Andre' 991111
        // 175
-       LFUN_PREFERENCES_SAVE,          // Lgb 991127
+/**
+ * LFUN_PREFERENCES_SAVE
+ * \li Action: Save user preferences.
+ * \li Syntax: preferences-save
+ * \li Origin: Lgb, 27 Nov 1999
+ */
+       LFUN_PREFERENCES_SAVE,
        LFUN_HELP_OPEN,                 // Jug 990627
        LFUN_DATE_INSERT,               // jdblair 20000131
        LFUN_LANGUAGE,                  // Dekel 20000203
@@ -540,19 +552,74 @@ enum kb_action {
        LFUN_INSET_REFRESH,
        LFUN_BUFFER_NEXT,
        LFUN_BUFFER_PREVIOUS,
-       LFUN_WORDS_COUNT,
+/**
+ * LFUN_STATISTICS
+ * \li Action: Count the statistics (number of words and characters)
+               in the document or in the given selection.
+ * \li Notion: Note that this function gives the number of words/chars written,
+               not the number of characters which will be typeset.
+ * \li Syntax: statistics
+ * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
+ */
+       LFUN_STATISTICS,
        // 260
        LFUN_CHANGES_OUTPUT,             // jspitzm 20050121
        LFUN_BIBTEX_DATABASE_ADD,
        LFUN_BIBTEX_DATABASE_DEL,
        LFUN_CITATION_INSERT,
-       LFUN_OUTLINE_UP,                 // Vermeer 20060323
+/**
+ * LFUN_OUTLINE_UP
+ * \li Action: Move the current group in the upward direction in the
+               structure of the document.
+ * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
+               the whole substructure of the group.
+ * \li Syntax: outline-up
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
+       LFUN_OUTLINE_UP,
        // 265
+/**
+ * LFUN_OUTLINE_DOWN
+ * \li Action: Move the current group in the downward direction in the
+               structure of the document.
+ * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
+               the whole substructure of the group.
+ * \li Syntax: outline-down
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_DOWN,
+/**
+ * LFUN_OUTLINE_IN
+ * \li Action: Moves the current group in the downward direction in the
+               hierarchy of the document structure.
+ * \li Notion: Part -> Chapter -> Section -> etc.
+ * \li Syntax: outline-in
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_IN,
+/**
+ * LFUN_OUTLINE_OUT
+ * \li Action: Moves the current group in the upward direction in the
+               hierarchy of the document structure.
+ * \li Notion: Part <- Chapter <- Section <- etc.
+ * \li Syntax: outline-out
+ * \li Origin: Vermeer, 23 Mar 2006
+ */
        LFUN_OUTLINE_OUT,
-       LFUN_PARAGRAPH_MOVE_DOWN,        // Edwin 20060408
-       LFUN_PARAGRAPH_MOVE_UP,          // Edwin 20060408
+/**
+ * LFUN_PARAGRAPH_MOVE_DOWN
+ * \li Action: Moves the current paragraph downwards in the document.
+ * \li Syntax: paragraph-move-down
+ * \li Origin: Edwin, 8 Apr 2006
+ */
+       LFUN_PARAGRAPH_MOVE_DOWN,
+/**
+ * LFUN_PARAGRAPH_MOVE_UP
+ * \li Action: Moves the current paragraph upwards in the document.
+ * \li Syntax: paragraph-move-up
+ * \li Origin: Edwin, 8 Apr 2006
+ */
+       LFUN_PARAGRAPH_MOVE_UP,
        // 270
        LFUN_BUFFER_TOGGLE_COMPRESSION,  // bpeng 20060427
        LFUN_MATH_BIGDELIM,
@@ -568,7 +635,7 @@ enum kb_action {
  * \li Action: Clears the list of saved bookmarks
  * \li Syntax: bookmark-clear
  * \li Origin: bpeng, 31 October 2006
-       */
+ */
        LFUN_BOOKMARK_CLEAR,             // bpeng 20061031
        LFUN_NOMENCL_INSERT,             // Ugras
        // 280
@@ -769,7 +836,7 @@ enum kb_action {
  * \li Params: <TYPE>:  line|page\n
                <QUANTITY>: up|down|<number>\n
  * \li Origin: Abdelrazak Younes, Dec 27 2007
-*/
+ */
        LFUN_SCROLL,
        LFUN_LASTACTION                  // end of the table
 };