* Doxy

[lyx.git] / src / LyXAction.cpp

diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index b67b9843fac9d520dce82cd5370c96611c1e10c9..b64c4639f9ec4806b5c4ad5f8dec585bf34b25e8 100644 (file)
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -104,98 +104,115 @@ void LyXAction::init()
 #endif
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_ACUTE
- * \li Action: adds an acute accent (á) to the next character typed
+ * \li Action: adds an acute accent \htmlonly (á)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-acute
  */
                { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_BREVE
- * \li Action: adds a breve accent to the next character typed
+ * \li Action: adds a breve accent \htmlonly (ă)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-breve
  */
                { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_CARON
- * \li Action: adds a caron to the next character typed
+ * \li Action: adds a caron \htmlonly (ǎ)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-caron
  */
                { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_CEDILLA
- * \li Action: adds a cedilla (ç) to the next character typed
+ * \li Action: adds a cedilla \htmlonly (ç)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-cedilla
  */
                { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCLE
- * \li Action: adds a circle accent (Å) to the next character typed
+ * \li Action: adds a circle accent \htmlonly (å)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-circle
  */
                { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCUMFLEX
- * \li Action: adds a circumflex (â) to the next character typed
+ * \li Action: adds a circumflex \htmlonly (ê)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-circumflex
  */
                { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_DOT
- * \li Action: adds a dot accent to the next character typed
+ * \li Action: adds a dot accent \htmlonly (ż)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-dot
  */
                { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_GRAVE
- * \li Action: adds a grave accent (à) to the next character typed
+ * \li Action: adds a grave accent \htmlonly (è)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-grave
  */
                { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
- * \li Action: adds a Hungarian umlaut to the next character typed
+ * \li Action: adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-grave
  */
                { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_MACRON
- * \li Action: adds a macron to the next character typed
+ * \li Action: adds a macron \htmlonly (ā)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-macron
  */
                { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_OGONEK
- * \li Action: adds an ogonek accent to the next character typed
+ * \li Action: adds an ogonek accent \htmlonly (ą)\endhtmlonly
+               to the next character typed
  * \li Syntax: accent-ogonek
  */
                { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
                { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_TIE
- * \li Action: adds a tie over the next two character typed
+ * \li Action: adds a tie \htmlonly (a͡)\endhtmlonly
+               over the next two character typed
+ * \li Notion: the following char will finish the tie.
  * \li Syntax: accent-tie
  */
                { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_TILDE
- * \li Action: adds a tilde (ñ) over the next character typed
+ * \li Action: adds a tilde \htmlonly (ã)\endhtmlonly
+               over the next character typed
  * \li Syntax: accent-tilde
  */
                { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_UMLAUT
- * \li Action: adds an umlaut (ö) over the next character typed
+ * \li Action: adds an umlaut \htmlonly (ä)\endhtmlonly
+               over the next character typed
  * \li Syntax: accent-umlaut
  */
                { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERBAR
- * \li Action: adds a bar under the next character typed
+ * \li Action: adds a bar \htmlonly (a̠)\endhtmlonly
+               under the next character typed
  * \li Syntax: accent-underbar
  */
                { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERDOT
- * \li Action: adds a dot under the next character typed
+ * \li Action: adds a dot \htmlonly (ạ)\endhtmlonly
+               under the next character typed
  * \li Syntax: accent-underdot
  */
                { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
@@ -218,26 +235,31 @@ void LyXAction::init()
  * \var lyx::kb_action lyx::LFUN_CAPTION_INSERT
  * \li Action: Inserts a caption inset.
  * \li Syntax: caption-insert
+ * \li Origin: Lgb, 18 Jul 2000
  */
                { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_DATE_INSERT
  * \li Action: Inserts the current date
- * \li Syntax: date-insert <ARG>
- * \li Param: <ARG>: Strangely, this is inserted verbatim, no matter
-                     what it is.
+ * \li Syntax: date-insert [<ARG>]
+ * \li Param: <ARG>: Format of date. The default value (%x) can be set
+                     in Preferences->Date format. For possible formats
+                     see manual page of strftime function.
+ * \li Origin: jdblair, 31 Jan 2000
  */
                { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
  * \li Action: Inserts a footnote inset.
  * \li Syntax: footnote-insert
+ * \li Origin: Jug, 7 Mar 2000
  */
                { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_ERT_INSERT
  * \li Action: Inserts an ERT inset.
  * \li Syntax: ert-insert
+ * \li Origin: Jug, 18 Feb 2000
  */
                { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
                { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
@@ -253,30 +275,35 @@ void LyXAction::init()
  * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
  * \li Action: Inserts an optional-argument (short title) inset.
  * \li Syntax: optional-insert
+ * \li Origin: Martin, 12 Aug 2002
  */
                { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_LINE_INSERT
  * \li Action: Inserts a horizontal line.
  * \li Syntax: line-insert
+ * \li Origin: poenitz,  Oct 27 2003
  */
                { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
  * \li Action: Inserts a new page.
  * \li Syntax: newpage-insert
+ * \li Origin: uwestoehr, 24 Nov 2007
  */
                { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
  * \li Action: Inserts a pagebreak.
  * \li Syntax: pagebreak-insert
+ * \li Origin: poenitz,  Oct 27 2003
  */
                { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
  * \li Action: Inserts a marginal note.
  * \li Syntax: marginalnote-insert
+ * \li Origin: Lgb, 26 Jun 2000
  */
                { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 /**
@@ -285,12 +312,14 @@ void LyXAction::init()
  * \li Syntax: unicode-insert <CHAR>
  * \li Params: <CHAR>: The character to insert, given as its code
                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
+ * \li Origin: Lgb, 22 Oct 2006
  */
                { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 /**
  * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
  * \li Action: Inserts a new listings inset.
  * \li Syntax: listing-insert
+ * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
  */
                { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
                { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },