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 7cc5542594c96746cecdd14a2d0dd87f7a124218..b937b30d70ba055bab914b2c02154cef631700b6 100644 (file)
--- 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 },
 
 /*!