浏览代码

- Importer::ReadFileFromMemory/aiImportFileFromMemory() clarify wording in documentation

Alexander Gessler 12 年之前
父节点
当前提交
260568912c
共有 2 个文件被更改,包括 12 次插入9 次删除
  1. 5 4
      include/assimp/Importer.hpp
  2. 7 5
      include/assimp/cimport.h

+ 5 - 4
include/assimp/Importer.hpp

@@ -409,11 +409,12 @@ public:
 	 *   instance. Use GetOrphanedScene() to take ownership of it.
 	 *
 	 * @note This is a straightforward way to decode models from memory
-	 * buffers, but it doesn't handle model formats spreading their 
+	 * buffers, but it doesn't handle model formats that spread their 
 	 * data across multiple files or even directories. Examples include
-	 * OBJ or MD3, which outsource parts of their material stuff into
-	 * external scripts. If you need the full functionality, provide
-	 * a custom IOSystem to make Assimp find these files.
+	 * OBJ or MD3, which outsource parts of their material info into
+	 * external scripts. If you need full functionality, provide
+	 * a custom IOSystem to make Assimp find these files and use
+	 * the regular ReadFile() API.
 	 */
 	const aiScene* ReadFileFromMemory( 
 		const void* pBuffer,

+ 7 - 5
include/assimp/cimport.h

@@ -170,11 +170,13 @@ ASSIMP_API const C_STRUCT aiScene* aiImportFileExWithProperties(
  *   Check the return value, and you'll know ...
  * @return A pointer to the imported data, NULL if the import failed.
  *
- * @note This is a straightforward way to decode models from memory buffers, but it 
- * doesn't handle model formats spreading their data across multiple files or even
- * directories. Examples include OBJ or MD3, which outsource parts of their material
- * stuff into external scripts. If you need the full functionality, provide a custom 
- * IOSystem to make Assimp find these files.
+ * @note This is a straightforward way to decode models from memory
+ * buffers, but it doesn't handle model formats that spread their 
+ * data across multiple files or even directories. Examples include
+ * OBJ or MD3, which outsource parts of their material info into
+ * external scripts. If you need full functionality, provide
+ * a custom IOSystem to make Assimp find these files and use
+ * the regular aiImportFileEx()/aiImportFileExWithProperties() API.
  */
 ASSIMP_API const C_STRUCT aiScene* aiImportFileFromMemory( 
 	const char* pBuffer,