]> git.lyx.org Git - lyx.git/blobdiff - src/LyXAction.cpp
Some comments.
[lyx.git] / src / LyXAction.cpp
index 7cc5542594c96746cecdd14a2d0dd87f7a124218..92f8173113d12721bc64a17975a4a727f1d44a4b 100644 (file)
@@ -341,6 +341,13 @@ void LyXAction::init()
  * \endvar
  */
                { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
+ * \li Action: Inserts branch inset.
+ * \li Syntax: branch-insert <BRANCH-NAME>
+ * \li Origin: vermeer, Aug 17 Aug 2003
+ * \endvar
+ */
                { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
                { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 /*!
@@ -1433,10 +1440,8 @@ void LyXAction::init()
                { LFUN_ESCAPE, "escape", ReadOnly, Edit },
 
                { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
-               { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
                { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
                { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
-               { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
 /*!
  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
  * \li Action: Sets the cursor position based on the row number of generated TeX file.
@@ -1446,8 +1451,36 @@ void LyXAction::init()
  */
                { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
                { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
+ * \li Action: Sets the cursor position based on the editing area coordinates
+               (similar as clicking on that point with left mouse button).
+ * \li Syntax: server-set-xy <X> <Y>
+ * \endvar
+ */
                { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
+ * \li Action: Returns the coordinates of cursor position in the editing area.
+ * \li Syntax: server-get-xy
+ * \endvar
+ */
+               { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
 
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
+ * \li Action: Generates the code (literate programming).
+ * \li Notion: Latex file with extension \literate_extension is generated.
+               Then LyX invokes \build_command (with a default of``make'') to generate the code and
+              \build_error_filter to process the compilation error messages. \n
+              In case you want to process your literate file with a script, or some other program,
+              just insert in your lyxrc file an entry with:\n
+              \build_command "my_script my_arguments" \n
+              The \build_error_filter differs from the \literate_error_filter only in that the
+              former will identify error messages from your compiler.
+ * \li Syntax: build-program
+ * \endvar
+ */
                { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
 
 /*!