[fixed]setDebugDataVisible, wrong data type in docs

Acki · Post by **Acki** » Thu Nov 20, 2008 1:52 am

Hi,
there is a typo in the api with setDebugDataVisible
it says: setDebugDataVisible(s32 state)
but state is not s32, but E_DEBUG_SCENE_TYPE !!!

(well, I know it is in fact s32 though

)
this makes it hard to find the possible state types and even harder to know that there are different types avilable...

now you'll have to follow the link to ISceneNode.h and from there the link to EDebugSceneTypes.h to find the state types...
but if you don't know that there are different types avilable you'll never find it...

it would be great if state was declared as E_DEBUG_SCENE_TYPE so you have a direct link to the types !!!

hybrid · Post by **hybrid** » Thu Nov 20, 2008 9:20 am

The parameter is not of that enum type, but a bitwise OR of all the enabled states. Hence, it doesn't really map to one of the enum values, except if exactly one debug state is enabled. But the enum type could be mentioned in the docs of course...

Acki · Post by **Acki** » Thu Nov 20, 2008 2:57 pm

hybrid wrote:But the enum type could be mentioned in the docs of course...

that would be great !!!

rogerborg · Post by **rogerborg** » Thu Nov 20, 2008 11:33 pm

Comment updated in SVN 1791 (1.4 branch) and 1792 (trunk). Thanks for pointing this out, I've been meaning to fix it for ages.

hybrid · Post by **hybrid** » Fri Nov 21, 2008 12:12 am

Althought 1785 already fixed it for trunk somehow

rogerborg · Post by **rogerborg** » Fri Nov 21, 2008 12:23 pm

I added a @ref...