Minor Documentation Concern

Austin Bonander <[email protected]>
Newsgroups gmane.comp.graphics.crystalspace.devel
Message-ID <CAKeFHErwd-VpE+z2aXokpA2PGWrWnwh=CECyGL9q4+63dE59sw@mail.gmail.com>
In the CS trunk documentation page 4.16.1, "Loading a Level", under the
heading "Getting the Level Loader Plugin":

"To finally be able to use the level loader in your application you need to
do:


csRef<iLoader> level_loader = csQueryRegistry<iLoader> (object_reg);

When you don't need it anymore you must call level_loader->DecRef ()."

The manual is telling the user to DecRef () a csRef<>, when in "Correctly
Using Smart Pointers" (4.3.2) it tells the user specifically to NOT do this
"except in very specialized cases, and only when you know exactly what you
are doing and why you are doing it."

If this is one of those cases, then I feel this should be clarified.
Otherwise, the user should be steered away from such dangerous behaviour.

-Austin Bonander

Form and Function Studios

Lead Developer, *Project Genesis*

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

_______________________________________________
Crystal-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/crystal-develop
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.