Op woensdag 23-01-2008 om 15:16 uur [tijdzone +0200], schreef Adrian Maier:
> > > Are there any people still interested in making it possible to have some > > > real > > > docs for sqldb and fcl-db ? > > > > I really would like it if such documentation will arise. But I also > > would like to add index-support and some more TClientDataset > > functionality. > > > > > If so, let's organize ourselves and see what needs to be done . I am very > > > interested in the subject but I can't do it myself alone : if I knew > > > enough > > > about sqldb I wouldn't be so unhappy about the lack of documentation . > > > > I'm the one who knows the most of sqldb, apart from some parts which > > aren't written by me. I would really like to help and eventually I'll > > start writing the documentation on my own. but I doubt if I'm the right > > person to do that now. But I'm willing to help and answer all questions. > > > > About the structure: I think it's best to use fpdoc to build the > > documentation. Just like Delphi does. Then in the descriptions of the > > components itself a short description of the whole component can be > > given, to explain the basics to new users. From there they can browse > > further into the documentation. > > > > So that's a completely different approach then suggested by Lars. > > In my opinion there are two distinct kinds of documentation that we > need : > - the reference documentation (which describes what does each > of the classes,methods,etc. do. With a few examples) > - a guide which explains the infrastructure, what are the components > involved, how to do typical things , etc. > > I know very little about fpdoc, but my feeling is that it's only suitable for > having the reference docs for sqldb and fcl-db. Yes, fpdoc is only for the reference documentation. > But anyway , the first thing we need is the full reference docs for the > units involved. The guide can wait. > So, I'll start by seeing exactly how does fpdoc work. If you use Lazarus, you can use LazDoc. Joost. _______________________________________________ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
