Mail Archives: djgpp-workers/1998/02/02/00:27:37
Randy Maas wrote:
>
> I've attached some diffs to fsext.txh. I hope they are an improvement on
> the current documentation of __FSEXT_{set,get}_data. I've tried to provide
> a somewhat realistic example, although it is not very short. I've
> sprinkled the example with comments, making it a little bigger.
I didn't have a really good look at the example (as in details of
operation), but the general structure looks good and an example is
always good to have (length is irrelevant so long as everything is
covered and there's no extra fluff).
Has your example been tested? That's really the most important thing.
A non-working example is next to useless.
I just noticed one flaw in your example; just what does it do? You
should explain what the code is trying to do. It *looks* like it's
providing memory based temporary files, but your docs should say so
specifically. Also, IMHO, if you're going to provide sample code, you
should provide a complete, working example. Those `...'s at the end of
my_fsext make it non compileable. Ideally, a programmer should be able
to cut and paste example code into an empty file, save it, and have it
compile and run.
Bill
--
Leave others their otherness.
- Raw text -