Possible error in documentation.

SGDK only sub forum

Moderator: Stef

Post Reply
orlanrod
Very interested
Posts: 99
Joined: Fri Sep 25, 2015 7:46 pm

Possible error in documentation.

Post by orlanrod » Thu Oct 15, 2015 4:25 am

Looking over a part of the doc, i see a statement that does not relate to what the function does. Highlighted in bold.
If its not an error, sorry. :mrgreen:
"
Function Documentation

void SPR_clear ( )
Test if specified sprites are in collision.

Parameters:
sprite1 first sprite.
sprite2 second sprite.
Returns:
TRUE if sprite1 and sprite2 are in collision, FALSE otherwise.

Clear all displayed sprites.
This actually clear the list cache and send it to the hardware (VDP) at Vint.
"

Stef
Very interested
Posts: 3131
Joined: Thu Nov 30, 2006 9:46 pm
Location: France - Sevres
Contact:

Re: Possible error in documentation.

Post by Stef » Thu Oct 15, 2015 7:50 am

That is actually an error but the doxygen parser, if you go to the spiter_eng.h file you will see the collision code is entirely commented.

orlanrod
Very interested
Posts: 99
Joined: Fri Sep 25, 2015 7:46 pm

Re: Possible error in documentation.

Post by orlanrod » Thu Oct 15, 2015 10:07 pm

Stef wrote:That is actually an error but the doxygen parser, if you go to the spiter_eng.h file you will see the collision code is entirely commented.
Ah i see. I'll make sure to take a look into the headers themselves.

Post Reply