Pavel Sanda wrote:
Can't we just put the comments in the C++ file?
This would even let us the keep the 'historical' lfun order.
in case your clean-coding heart can accept this patch, i can move
the doxies to .cpp file.
That's a bit weird but I am fine with it provided that you explain the
'
Pavel Sanda wrote:
the moment you put it outside of the lfuns.h into another file doxygen wont find it. i tried various
"lyx::" & "kb_action::" prefixes permutations wihtout success.
!$!$#%^*&%$&*&%#%#$%@@@ !
/*cough*/ /*cough*/
one spends hours of reading various docs to finally find
> Can't we just put the comments in the C++ file?
>
> This would even let us the keep the 'historical' lfun order.
in case your clean-coding heart can accept this patch, i can move
the doxies to .cpp file.
pavel
diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 243e2f9..513257a 100644
---
> > Following this idea, the dox comment would look like this in
> > LyXAction::init():
> >
> >
> > ev_item const items[] = {
> > /** \var kb_action::LFUN_ACCENT_ACUTE
>
> fyi /*! \var
>
> > * \li Action:
> > * \li Syntax:
> > *
> > ev_item const items[] = {
> > /** \var kb_action::LFUN_ACCENT_ACUTE
>
> fyi /*! \var
sorry this is not needed.
>
> > * \li Action:
> > * \li Syntax:
> > */
> > { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Layout },
> Following this idea, the dox comment would look like this in
> LyXAction::init():
>
>
> ev_item const items[] = {
> /** \var kb_action::LFUN_ACCENT_ACUTE
fyi /*! \var
> * \li Action:
> * \li Syntax:
> */
>
Abdelrazak Younes wrote:
Pavel Sanda wrote:
All the LFUNs can be documented in one place just before
'LyXAction::init()'.
on contrary i would like to make the comment to each lfun separately
as it is now.
the moment we keep the comments elsewhere people will forget to add
the doxy
(and it w
Pavel Sanda wrote:
All the LFUNs can be documented in one place just before 'LyXAction::init()'.
on contrary i would like to make the comment to each lfun separately as it is
now.
the moment we keep the comments elsewhere people will forget to add the doxy
(and it will be pain to keep it synch
>>> I am sure this is possible with Doxygen. In another project I have short
>>> comments (i.e. titles) in *.h and detailed comments in *.cpp. This works
>> in array initialization items, yes?
>
> Yes, in this method.
i meant _inside_ the initialization, ie:
ev_item const items[] =
>> When you say, "the cpp file", which file do you mean?
>
> I am talking about LyXAction.cpp.
right
>All the LFUNs can be documented in one place just before 'LyXAction::init()'.
on contrary i would like to make the comment to each lfun separately as it is
now.
the moment we keep the comments
On Tue, 8 Jan 2008, Abdelrazak Younes wrote:
> To recap, in .h :
>
> /// This is a class.
No the trailing dot as in '.' in '/// This is a class.'
Thanks for the clarification,
Christian
--
Christian Ridderström, +46-8-768 39 44 http://www.md.kth.se/~chr
[EMAIL PROTECTED] wrote:
On Tue, 8 Jan 2008, Abdelrazak Younes wrote:
To recap, in .h :
/// This is a class.
/**
* Detailed doc about the class...
*
**/
class foo
{
/// This is a method.
void bar();
}
And in the .cpp:
/**
* Detailed doc about the method...
*
**/
void fo
rgheck wrote:
Pavel Sanda wrote:
ii) if there is a way how to output list from the doxies around
LFUNS in the .cpp file then
a) firstly resort them thematically - this can take
some time to get it 'right'
b) later move doxy comment there from .h
When you say, "the cpp fi
Pavel Sanda wrote:
ii) if there is a way how to output list from the
doxies around LFUNS in the .cpp file then
a) firstly resort them thematically - this can take
some time to get it 'right'
b) later move doxy comment there from .h
When you say, "the cpp file", which file
On Tue, 8 Jan 2008, Pavel Sanda wrote:
thats all possible, but i'll be more happy to concentrate our energy
into real stuffing the doxy data then to spent it on all the whistles
and bells around :)
Well, I like writing wiki whistles ;-)
Anyway, my initial thought was to simply point (advanc
On Tue, 8 Jan 2008, Abdelrazak Younes wrote:
To recap, in .h :
/// This is a class.
/**
* Detailed doc about the class...
*
**/
class foo
{
/// This is a method.
void bar();
}
And in the .cpp:
/**
* Detailed doc about the method...
*
**/
void foo::bar()
{...}
Th
> When you talk about 'transform it little', is that from HTML to wiki markup
> or something? (Not sure what we gain?)
if you look on the link of the generated page, there are tons of other unneeded
stuff as far as LFUNS concerned. so the idea was not to make the trnaformations
from html to othe
Pavel Sanda wrote:
I am sure this is possible with Doxygen. In another project I have short
comments (i.e. titles) in *.h and detailed comments in *.cpp. This works
in array initialization items, yes?
Yes, in this method.
i tried again and failed - can you show me an example?
Are you usi
Pavel Sanda wrote:
> Do we really want to use doxygen on the file, or is he plan to write
> some script that creates a wiki page or lyx document from this data?
i already use it. my intetion was to take the output html page and then
transform it little by some script.
My (lazy) plan was to in
> a) firstly resort them thematically - this can take
in the .cpp file of course
p
> I am sure this is possible with Doxygen. In another project I have short
> comments (i.e. titles) in *.h and detailed comments in *.cpp. This works
in array initialization items, yes?
i tried again and failed - can you show me an example?
> quite well and I think we should standardize on that
Pavel Sanda wrote:
Do we really want to use doxygen on the file, or is he plan to write
some script that creates a wiki page or lyx document from this data?
i already use it. my intetion was to take the output html page and then
transform it little by some script.
Sounds cool!
but its possi
> Do we really want to use doxygen on the file, or is he plan to write
> some script that creates a wiki page or lyx document from this data?
i already use it. my intetion was to take the output html page and then
transform it little by some script. but its possible to forget all
about doxygen, pu
Pavel Sanda <[EMAIL PROTECTED]> writes:
>> Can't we just put the comments in the C++ file?
>
> if you show me how :)
> in other words i was not successful to generate doxygen output
> when putting the doxy entries in LyXAction.cpp. but i put just
> minimal effort to explore that possibility.
Do w
> Can't we just put the comments in the C++ file?
if you show me how :)
in other words i was not successful to generate doxygen output
when putting the doxy entries in LyXAction.cpp. but i put just
minimal effort to explore that possibility.
> This would even let us the keep the 'historical' lfun
On Mon, Jan 07, 2008 at 06:54:25PM -, [EMAIL PROTECTED] wrote:
> Author: sanda
> Date: Mon Jan 7 19:54:23 2008
> New Revision: 22422
>
> URL: http://www.lyx.org/trac/changeset/22422
> Log:
> Add lfuns doxy.
>
> Modified:
> lyx-devel/trunk/src/lfuns.h
>
> Modified: lyx-devel/trunk/src/lf
26 matches
Mail list logo
