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 4232fd5033d25328fcc2d28c6656b1bcc6da8e41..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,
@@ -379,6 +398,8 @@ enum kb_action {
        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
 };