Minor error in Autodocs arexx_cl.doc.txt

Report errors, omissions, etc. regarding the AmigaOS Documentation Wiki here.
Post Reply
User avatar
OldFart
Posts: 104
Joined: Tue Jul 12, 2011 3:56 pm
Location: Groningen, Netherlands

Minor error in Autodocs arexx_cl.doc.txt

Post by OldFart »

Hi,

Under the tag:

Code: Select all

AREXX_Commands (struct ARexxCmd *)
,
this description for member ac_Func is given:

Code: Select all

ac_Func (*()(struct ARexxCmd *, struct RexxMsg *))
	        A pointer to the function that will be called when this
	        command is received by your programme. The function will
	        get past a pointer to its ARexxCmd entry and the RexxMsg
	        structure received for the command. You may use this
	        for setting ARexx variables but please note that it may
	        be NULL.
I think this should read:

Code: Select all

ac_Func (*()(struct ARexxCmd *, struct RexxMsg *))
	        A pointer to the function that will be called when this
	        command is received by your programme. The function will
	        get passed a pointer to its ARexxCmd entry and the RexxMsg
	        structure received for the command. You may use this
	        for setting ARexx variables but please note that it may
	        be NULL.
The error is in the word 'past' vs 'passed'.

Btw, apart from 'bots' is anyone else paying any attention to these 'detections'?

OldFart
X5000, appears to be sick. Dismantled jan 1, 2024.
Dead MicroA1
A1200 in ElBox, c/w Blizzard '040 @ 50MHz + SCSI module, ZIV-board c/w (o.a.) cv64/3d + flickerdoubler + FastATA-ZIV + Lots of SCSI gear, sitting idle.
RaspBerry Pi 2B, 3B, 4B/4Gb, 4B/8Gb
OrangePi 5+ 8Gb
ACER Windows 10
User avatar
nbache
Beta Tester
Beta Tester
Posts: 1744
Joined: Mon Dec 20, 2010 7:25 pm
Location: Copenhagen, Denmark
Contact:

Re: Minor error in Autodocs arexx_cl.doc.txt

Post by nbache »

Thanks, bug report made in Bugzilla.

BTW, the file in question is arexx_cl.doc, not arexx_cl.doc.txt.

Best regards,

Niels
User avatar
colinw
AmigaOS Core Developer
AmigaOS Core Developer
Posts: 218
Joined: Mon Aug 15, 2011 10:20 am
Location: Brisbane, QLD. Australia.

Re: Minor error in Autodocs arexx_cl.doc.txt

Post by colinw »

You can close the bug report Niels, I just fixed the source code document,
so the next time the docs are regenerated, the typo will be gone.
User avatar
nbache
Beta Tester
Beta Tester
Posts: 1744
Joined: Mon Dec 20, 2010 7:25 pm
Location: Copenhagen, Denmark
Contact:

Re: Minor error in Autodocs arexx_cl.doc.txt

Post by nbache »

Thanks.

I set it to fixed, verification and closure will have to wait until next time it's built for beta.

(So now all we need is somebody finding a bug in the actual class ;-)).

Best regards,

Niels
User avatar
OldFart
Posts: 104
Joined: Tue Jul 12, 2011 3:56 pm
Location: Groningen, Netherlands

Re: Minor error in Autodocs arexx_cl.doc.txt

Post by OldFart »

@nbache:
The title in my browser reads:
@collinw & nbache
Thanks for the action undertaken.

OldFart
X5000, appears to be sick. Dismantled jan 1, 2024.
Dead MicroA1
A1200 in ElBox, c/w Blizzard '040 @ 50MHz + SCSI module, ZIV-board c/w (o.a.) cv64/3d + flickerdoubler + FastATA-ZIV + Lots of SCSI gear, sitting idle.
RaspBerry Pi 2B, 3B, 4B/4Gb, 4B/8Gb
OrangePi 5+ 8Gb
ACER Windows 10
Post Reply