[Lazarus] Documentation contribution

Felipe Monteiro de Carvalho felipemonteiro.carvalho at gmail.com
Sat Feb 11 09:38:11 CET 2012


On Fri, Feb 10, 2012 at 8:24 PM, Hans-Peter Diettrich
<DrDiettrich1 at aol.com> wrote:
> I only remember that you stated that you don't like such notes.

It is not about liking, I think it is just plainly obvious that if
someone downloads our software and builds our docs, presses F1 and
reads [really?] it makes us look ridiculous so it is not acceptable to
have that in our documentation.

> Such an entry is absolutely useless without instructions *what* should be
> implemented at all. If you can't see that yourself, then you better keep
> your hands off the documentation.

It doesn't matter if it wasnt good before. Your [?] tags make it worse.

>> <p>[this looks outdated?]
>> It is not outdated.
> Thanks for confirming your ignorance :-(
...
> If you had taken a look at Arc(), you certainly had noticed that the
> parameters "angle1" and "angle2" do not exist any more. Do you need better
> glasses?

function Arc(DC: HDC; Left,Top,Right,Bottom,Angle16Deg,
Angle16DegLength: Integer): Boolean; {$IFDEF
IF_BASE_MEMBER}virtual;{$ENDIF}

Then just change it to Angle16Deg and Angle16DegLength. From reading
"looks outdated" how am I supposed to know that you mean that the
parameter name is slightlt wrong? As far as I remember I wrote this
documentation, and it is not outdated, I just made a copy+paste error
in the parameter name because the function is nearly identical to its
twin sister from TCanvas and I was documenting both at the same time.

-- 
Felipe Monteiro de Carvalho




More information about the Lazarus mailing list