From: Pavel Sanda <sanda@lyx.org>
Date: Sun, 20 Apr 2008 22:36:07 +0000 (+0000)
Subject: One more doxy.
X-Git-Tag: 1.6.10~5075
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=5c501a64dd558392a0a974e285b2ffc0e24b1f72;p=features.git

One more doxy.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@24400 a592a061-630c-0410-9148-cb99ea01b6c8
---

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 7cc5542594..b937b30d70 100644
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -1448,6 +1448,20 @@ void LyXAction::init()
 		{ LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
 		{ LFUN_SERVER_SET_XY, "server-set-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 },
 
 /*!