On Mon, 7 Jan 2008, Pavel Sanda wrote:
If so, couldn't that be done in some other way? What if we just add
for instance a documentation section describing 'word-right',
'word-left', 'word-...' and then for the definition of 'word-right' etc
, we refer to that section.
i dont follow you exactly. can you show a code example of what you have in mind
?
I'm not familiar with doxygen, so just look at the example at the end as
something intended to illustrate what I mean. Basically I suggest allowing
the LFUN enums to be unsorted, but let the documentation of the LFUN refer
to small documentation sections that describe the category to which the
LFUN belongs. For instance, the LFUN 'char-backward' could refer to a
section that describes LFUNs that are related to cursor movement in
general. This section could for instance explain what 'backward' means
when using RTL. If we are ambitious, this section could also list the
LFUNs related to cursor movement.
My hope is that by referring to the sections I mentioned above, we don't
feel it is necessary to sort them now. (If we do sort them, I think they
should be sorted alphabetically).
Best regards,
/Christian
Here is an example that might work if it's placed in lfuns.h - I don't
have time to test it though:
----------------------------- lfuns.h ----------------------------
/*! \page lfunspage LyX Functions (LFUNs)
Some general info and introduction to LFUNs.
There are separate sections discussion categories of LFUNs,
e.g. LFUNs related to \ref lfunmovement "cursor movement".
\section lfunmovement LFUNs related to cursor movement
This sections discusses the LFUNs related to cursor movement,
e.g. 'char-backward'.
*/
// <snip>
enum kb_action {
// <snip>
LFUN_CHAR_BACKWARD,
/**
* LFUN_CHAR_BACKWARD
* \li Action: Move cursor backard one character
* \li Notion: Also see the section
\ref lfunmovement "LFUNs related to cursor movements".
* \li Syntax: char-backward
* \li Params: -
* \li Origin: Ancient...
*/
// <snip>
}
--
Christian Ridderström, +46-8-768 39 44 http://www.md.kth.se/~chr
