- Clarify documentation for Importer::GetOrphanedScene.

- Change doc revision to 590.
- Rebuild CHM doc (online docs updated as well).
- Add TBD entry to LWO loader to remind me if I find enough time to fix that.

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@591 67173fc5-114c-0410-ac8e-9d2fd5bffc1f

code/LWOLoader.cpp

@@ -973,6 +973,9 @@ void LWOImporter::LoadLWO2VertexMap(unsigned int length, bool perPoly)
 		return;
 
 	default: 
+		if (name == "APS.Level") {
+			// XXX handle this (seems to be subdivision-related).
+		}
 		DefaultLogger::get()->warn("LWO2: Skipping unknown VMAP/VMAD channel \'" + name + "\'"); 
 		return;
 	};

doc/Doxyfile

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = Assimp
-PROJECT_NUMBER         = r400
+PROJECT_NUMBER         = r590
 OUTPUT_DIRECTORY       = 
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English

include/assimp.hpp

@@ -490,9 +490,17 @@ public:
 	 *  will return NULL - until a new scene has been loaded via ReadFile().
 	 *
 	 * @return Current scene or NULL if there is currently no scene loaded
-	 * @note --- you know that the aiScene is allocated on Assimp's heap,
-	 *   so you need to call Assimp's delete if the heap is not shared?
-	 *   And that's why you shouldn't use this method at all. Thanks.*/
+	 * @note Use this method with maximal caution, and only if you have to.
+	 *   By design, aiScene's are exclusively maintained, allocated and
+	 *   deallocated by Assimp and no one else. The reasoning behind this
+	 *   is the golden rule that deallocations should always be done
+	 *   by the module that did the original allocation because heaps
+	 *   are not necessarily shared. GetOrphanedScene() enforces you
+	 *   to delete the returned scene by yourself, but this will only
+	 *   be fine if and only if you're using the same heap as assimp.
+	 *   On Windows, it's typically fine when everything is linked
+	 *   against the multithreaded-dll version of the runtime library.
+	 *   It will work as well for static linkage with Assimp.*/
 	aiScene* GetOrphanedScene();
 
 	// -------------------------------------------------------------------