From: Pavel Sanda Date: Sun, 10 Jan 2010 16:50:25 +0000 (+0000) Subject: Add doxy samples from commit info. X-Git-Tag: 2.0.0~4447 X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=5026c87e4ccaaecc13f2396aa437f878f4cef879;p=features.git Add doxy samples from commit info. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32945 a592a061-630c-0410-9148-cb99ea01b6c8 --- diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp index 6b6a982aa6..bcf4210886 100644 --- a/src/LyXAction.cpp +++ b/src/LyXAction.cpp @@ -3448,19 +3448,24 @@ void LyXAction::init() /*! * \var lyx::FuncCode lyx::LFUN_INSET_FORALL - - * \li Action: Apply the given commands on insets of a given name. WARNING: use - at your own risks; this function gives you too many ways of - shooting yourself in the foot. A typical example is + * \li Action: Apply the given commands on insets of a given name. + * \li Notion: WARNING: use at your own risks; this function gives + you too many ways of shooting yourself in the foot. + A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000. - * \li Syntax: inset-forall + * \li Syntax: inset-forall \n : Type of Inset. If is *, all insets are matched. - * \li Sample: The name is used like for InsetLayout in layout files: "Note" - matches all note insets, while "Note:Note" only matches LyX - yellow note insets. The following command closes all note insets \n - inset-forall Note inset-toggle close + The name is used like for InsetLayout in layout files: "Note" + matches all note insets, while "Note:Note" only matches LyX + yellow note insets. + * \li Sample: Remove all index insets: \n + inset-forall Index delete-char-forward \n + Close all Notes (also works for a particular branch, for example): \n + inset-forall Note inset-toggle close \n + Try to put LyX in an infinite loop if there is at least a Note: \n + inset-forall Note char-backward * \li Origin: lasgouttes, 27 Nov 2009 * \endvar */