Sorry Pavel,
I patched away without checking my e-mail and didn't see your reply
about wanting to keep the double slasheh. I respect your decision
completely. My question is now about the double slashes in the LFUN
below.
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
* \li Action: Change paragraph settings.
* \li Notion: Modifies the current paragraph, or currently selected paragraphs.
This function only modifies, and does not override,
existing settings.
Note that the "leftindent" indent setting is deprecated.
* \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
* \li Params: <INDENT>:
\\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
<SPACING>: \\paragraph_spacing
default|single|onehalf|double|other\n
<ALIGN>: \\align block|left|right|center|default\n
<OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
* \li Origin: rgh, Aug 15 2007
* \endvar
*/
Are the PARAGRAPH_PARAMS params intended to have double slashes or
are they escaped, single slashes? If the intention is to have the
comments as literal as possible, relying on interpreting them with a
python script, and leaving doxygen with a few errors, then I propose
that we go for something consistent, and document this clearly at the
top of LyXAction.cpp. Here's what I sense is the current situation:
* any \htmlonly text in the fields needs to be stripped
* any references to other LFUNs need the # removing, although a proper
LyX cross-reference could be implemented
* any occurrences of \n in the fields must be replaced by the lyx
ctrl-enter stuff i.e.
\begin_inset Newline newline
\end_inset
* any occurrences of a \ (obviously not including \n) must become a
\backslash surrounded by newlines as is the .lyx file syntax
* long lists of parameters need to be chopped and put over multiple lines
* someone mentioned alphabetical sorting, this could be done too
I am happy to implement these thing in python, but I think before I
spend time trying to guess the intended layout of LyXAction.cpp, and
implementing things in a way that isn't wanted, we should come to an
agreement about what is to be achieved and how. This will (I think...)
require some changes in LyXAction.cpp as I don't feel that it's
consistent, though I may just be missing something - I am new to this.
Once again, sorry for not recognising your verdict on the double
slashes and posting a patch, I didn't intend to contravene, I just
didn't see the email requesting that single slashes stay.
Ewan
