On Fri, Nov 08, 2002 at 12:22:35AM +1100, Ben Stanley wrote:
> I think I could also move several methods in LyXtextclass from public to
> private.
Such would be welcome ;-)
Andre'
--
Those who desire to give up Freedom in order to gain Security,
will not have, nor do they deserve, either one. (
On Fri, Nov 08, 2002 at 12:22:35AM +1100, Ben Stanley wrote:
> Here it is.
applied. (actually it would be nice to document what the ctor takes as
arguments)
> I think I could also move several methods in LyXtextclass from public to
> private.
I guess you can spupply a patch for that too ?
tha
On Thu, Nov 07, 2002 at 02:00:47PM +0100, Andre Poenitz wrote:
> No. The code _is_ the documentation. If it is unreadable, it is broken.
> I know that we do not live in an ideal world, though, and LyX code _is_
> broken by this standard. But instead commenting the broken code, the code
> should be
On Fri, 2002-11-08 at 00:00, Andre Poenitz wrote:
> Ben wrote
> > I will make a new patch.
>
> Thank you.
>
> Andr'e
Here it is.
I think I could also move several methods in LyXtextclass from public to
private.
I intend next to do similar documentation on some other classes,
specifically thi
On Thu, Nov 07, 2002 at 11:11:46PM +1100, Ben Stanley wrote:
> There is no way for the compiler to check that the subroutine does what
> it was supposed to do, either. And there is no way for the reader of the
> code to guess why something was done in a particular way unless it was
> documented.
N
On Thu, 2002-11-07 at 21:05, Andre Poenitz wrote:
> On Thu, Nov 07, 2002 at 12:34:56PM +1100, Ben Stanley wrote:
> > I will try to separate these things then, or at least put in \todo
> > comments where the code looks iffy and then go back to clean code later.
> > Doxygen can generate a page of \to
On Thu, Nov 07, 2002 at 12:34:56PM +1100, Ben Stanley wrote:
> I will try to separate these things then, or at least put in \todo
> comments where the code looks iffy and then go back to clean code later.
> Doxygen can generate a page of \todo items, which makes these things
> easy to find.
I beli
Ben Stanley <[EMAIL PROTECTED]> writes:
| The first style is a summary comment, and I use these in class
| declarations, i.e. header files. The second comment type is the in depth
| documentation, which I place above the function definition. When viewing
| the HTML documentation provided by Doxyge
On Thu, Nov 07, 2002 at 12:34:56PM +1100, Ben Stanley wrote:
> The first style is a summary comment, and I use these in class
> declarations, i.e. header files. The second comment type is the in depth
> documentation, which I place above the function definition. When viewing
> the HTML documentati
> Andre Poenitz <[EMAIL PROTECTED]> writes:
>
> | I think it would be prudent to split patches into "documentation stuff"
> | and "small code changes", maybe even to abstain from the small code changes
> | at all.
I will try to separate these things then, or at least put in \todo
comments where t
Andre Poenitz <[EMAIL PROTECTED]> writes:
| On Thu, Nov 07, 2002 at 02:58:45AM +1100, Ben Stanley wrote:
>> I'm trying to figure out what each function/member does by reading
>> through the code. I'd appreciate it if people could let me know when I
>> get things wrong, as I inevitably will with th
On Thu, Nov 07, 2002 at 02:58:45AM +1100, Ben Stanley wrote:
> I'm trying to figure out what each function/member does by reading
> through the code. I'd appreciate it if people could let me know when I
> get things wrong, as I inevitably will with the documentation in the
> state its in.
I think
Hi,
I'm trying to get an overview of the LyX code again, and I thought I'd
try to clean up the documentation while I'm doing it. I started with
LyXTextClass (no particular reason for choosing that file).
I'm trying to figure out what each function/member does by reading
through the code. I'd appr
13 matches
Mail list logo
