[fpc-devel] Question about writing documentation

[George Birbilis]

Why not say return <1 or <=0 for all?

----------------
George Birbilis (birbilis at kagi.com)
Computer & Informatics Engineer
Microsoft MVP J# for 2004-2006
Borland "Spirit of Delphi"
3D, QuickTime, QTVR, Java, Delphi,
ActiveX, .NET components, Robotics
http://www.kagi.com/birbilis
http://birbilis.spaces.live.com


> -----Original Message-----
> From: fpc-devel-bounces at lists.freepascal.org
> [mailto:fpc-devel-bounces at lists.freepascal.org] On Behalf Of
> Joost van der Sluis
> Sent: Friday, December 22, 2006 12:52 AM
> To: FPC developers' list
> Subject: [fpc-devel] Question about writing documentation
>
> Hi all,
>
> Two things:
>
> One: TDataset.Recordcount on Delphi (TclientDataset?) returns
> 0 if it's called on an inactive TDataset. But an exception
> seems to be more appropiate to me. But some
> dataset-descendents raise an exception, some return 0.
> Now what should I do in sqldb and the TMemDataset?
>
> Two: I want to document the choice I made in point one, and I
> think that the writing documentation at the same time is a
> good idea. But now I have this question: TDataset.Recordcount
> always return -1. Even if the TDataset is closed.
> Any comment on the exception in, for example,
> TMemDataset.Recordcount, should I place that in the
> TMemDataset.Recordcount-help? Or can I put into the
> TDataset.Recordcount a remark, that most TDataset.Descendents
> return 0 or raise an exception?
> Normally you would write that down in the documentation of
> the descendent, but I want to make a statement to
> TDataset-descendent- developers, that if they make their own
> descendent, it should return 0 or an exception. where's the
> place to do that?
>
> I hope my point is clear.
>
> Regards,
>   Joost.
>
>
> --
> Met vriendelijke groeten,
>
>   Joost van der Sluis
>   CNOC Informatiesystemen en Netwerken
>   http://www.cnoc.nl
>
> _______________________________________________
> fpc-devel maillist  -  fpc-devel at lists.freepascal.org
> http://lists.freepascal.org/mailman/listinfo/fpc-devel
> 



  _____  

avast! Antivirus <http://www.avast.com> : Outbound message clean. 


Virus Database (VPS): 0659-1, 16/12/2006
Tested on: 22/12/2006 9:44:37 p?
avast! - copyright (c) 1988-2006 ALWIL Software.