SCons: msvc does not need this /TP option any more after we rename .C => .cpp. Also...

[lyx.git] / src / lfuns.h

diff --git a/src/lfuns.h b/src/lfuns.h
index b5260611b4108f465cb352222fe11177aa9bc4df..7d4162f1e899dead655c87f2f1b8955ec26a4e92 100644 (file)
--- a/src/lfuns.h
+++ b/src/lfuns.h
@@ -29,6 +29,19 @@ namespace lyx {
  * BufferView::dispatch(), Cursor::dispatch() and
  * Inset*::doDispatch();
  */
+
+/** LFUN documentation (a start at least, Chr 2007-08-12)
+ *
+ * The documentation below is primarily notes about restrictions and
+ * oddities relating to the different LFUNs. Note that this
+ * documentation may well be moved to a more suitable location later
+ * on.
+ *
+ * The documentation is interspersed with the enum:s. Another choice
+ * was to put it in a separate list. The best choice was unclear, so
+ * this may change. Particularly if doxygen can be used somehow.
+ */
+
 enum kb_action {
        LFUN_UNKNOWN_ACTION = -1,
        // 0
@@ -39,6 +52,12 @@ enum kb_action {
        LFUN_BUFFER_WRITE,
        // 5
        LFUN_BUFFER_WRITE_AS,
+/**    LFUN_BUFFER_WRITE_AS,           
+ * Function:   Rename and save current buffer.
+ * Syntax:     buffer-write-as <filename>
+ * In:         <filename> = New name of the buffer/file. A relative path
+ *             is with respect to the original location of the buffer/file.
+ */
        LFUN_BUILD_PROGRAM,
        LFUN_BUFFER_VIEW,
        LFUN_BUFFER_CLOSE,
@@ -327,61 +346,60 @@ enum kb_action {
        LFUN_FINISHED_LEFT,
        // 245
        LFUN_FINISHED_RIGHT,
-       LFUN_FINISHED_UP,
-       LFUN_FINISHED_DOWN,
        LFUN_CHARSTYLE_INSERT,
        LFUN_WORD_FIND,
-       // 250
        LFUN_WORD_REPLACE,
        LFUN_BUFFER_EXPORT_CUSTOM,
+       // 250
        LFUN_BUFFER_PRINT,
        LFUN_NEXT_INSET_TOGGLE,
        LFUN_ALL_INSETS_TOGGLE,
-       // 255
        LFUN_BUFFER_LANGUAGE,
        LFUN_TEXTCLASS_APPLY,
+       // 255
        LFUN_TEXTCLASS_LOAD,
        LFUN_BUFFER_SAVE_AS_DEFAULT,
        LFUN_BUFFER_PARAMS_APPLY,
-       // 260
        LFUN_LYXRC_APPLY,
        LFUN_GRAPHICS_EDIT,
+       // 260
        LFUN_INSET_REFRESH,
        LFUN_BUFFER_NEXT,
        LFUN_BUFFER_PREVIOUS,
-       // 265
        LFUN_WORDS_COUNT,
        LFUN_CHANGES_OUTPUT,             // jspitzm 20050121
+       // 265
        LFUN_BIBTEX_DATABASE_ADD,
        LFUN_BIBTEX_DATABASE_DEL,
        LFUN_CITATION_INSERT,
-       // 270
        LFUN_OUTLINE_UP,                 // Vermeer 20060323
        LFUN_OUTLINE_DOWN,
+       // 270
        LFUN_OUTLINE_IN,
        LFUN_OUTLINE_OUT,
        LFUN_PARAGRAPH_MOVE_DOWN,                // Edwin 20060408
-       // 275
        LFUN_PARAGRAPH_MOVE_UP,                  // Edwin 20060408
        LFUN_BUFFER_TOGGLE_COMPRESSION,                 // bpeng 20060427
+       // 275
        LFUN_MATH_BIGDELIM,
        LFUN_CLIPBOARD_PASTE,
        LFUN_INSET_DISSOLVE,                 // jspitzm 20060807
-       // 280
        LFUN_CHANGE_NEXT,
        LFUN_WINDOW_NEW,                 // Abdel 20061021
+       // 280
        LFUN_WINDOW_CLOSE,               // Abdel 20061023
        LFUN_UNICODE_INSERT,             // Lgb 20061022
        LFUN_BOOKMARK_CLEAR,             // bpeng 20061031
-       // 285
-       LFUN_TOOLBAR_TOGGLE_STATE,       // bpeng 20061101
        LFUN_NOMENCL_INSERT,             // Ugras
        LFUN_NOMENCL_PRINT,              // Ugras
+       // 285
        LFUN_CLEARPAGE_INSERT,           // Ugras 20061125
        LFUN_CLEARDOUBLEPAGE_INSERT,     // Ugras 20061125
-       //290
        LFUN_LISTING_INSERT,             // Herbert 20011110, bpeng 20070502
        LFUN_TOOLBAR_TOGGLE,             // Edwin 20070521
+       LFUN_BUFFER_WRITE_ALL,           // rgh, gpothier 200707XX
+       //290
+       LFUN_PARAGRAPH_PARAMS,           // rgh, 200708XX
 
        LFUN_LASTACTION                  // end of the table
 };