]> git.lyx.org Git - lyx.git/commitdiff
doxy new LFUN_PARAGRAPH_GOTO parameter.
authorAbdelrazak Younes <younes@lyx.org>
Fri, 16 May 2008 12:55:19 +0000 (12:55 +0000)
committerAbdelrazak Younes <younes@lyx.org>
Fri, 16 May 2008 12:55:19 +0000 (12:55 +0000)
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@24799 a592a061-630c-0410-9148-cb99ea01b6c8

src/LyXAction.cpp

index 285b87cc928f1ede611c8e290b3d268cb8288d55..d8542fbf0099aa14601dd749d27d270a4a2d1374 100644 (file)
@@ -1079,10 +1079,13 @@ void LyXAction::init()
                { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
 /*!
  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
- * \li Action: Jump to a paragraph given by its id number.
+ * \li Action: Jump to a paragraph given by its id number and optionally the
+               desired position within the paragraph.
  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
                seen on the screen. Moreover the id is unique for all opened buffers (documents).
- * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
+ * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+ * \li Params: <PAR_ID_NUMBER>:  paragraph id
+               <POSITION_IN_PAR>: desired position within the paragraph
  * \li Origin: Dekel, 26 Aug 2000
  * \endvar
  */