- Details changed in the doxygen config

- Corrected some documentation comments
- removed aiDefs.h, it's not used anymore

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

doc/Doxyfile

@@ -1,4 +1,4 @@
-# Doxyfile 1.5.3
+# Doxyfile 1.5.4
 
 #---------------------------------------------------------------------------
 # Project related configuration options
@@ -11,9 +11,9 @@ CREATE_SUBDIRS         = YES
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
 REPEAT_BRIEF           = YES
-ABBREVIATE_BRIEF       = "The $name class " \
+ABBREVIATE_BRIEF       = "The $name class  " \
-                         "The $name widget " \
+                         "The $name widget  " \
-                         "The $name file " \
+                         "The $name file  " \
                          is \
                          provides \
                          specifies \
@@ -28,7 +28,7 @@ FULL_PATH_NAMES        = YES
 STRIP_FROM_PATH        = 
 STRIP_FROM_INC_PATH    = 
 SHORT_NAMES            = NO
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 QT_AUTOBRIEF           = NO
 MULTILINE_CPP_IS_BRIEF = NO
 DETAILS_AT_TOP         = NO
@@ -38,14 +38,16 @@ TAB_SIZE               = 8
 ALIASES                = 
 OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
-BUILTIN_STL_SUPPORT    = NO
+BUILTIN_STL_SUPPORT    = YES
 CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
 DISTRIBUTE_GROUP_DOC   = NO
 SUBGROUPING            = YES
+TYPEDEF_HIDES_STRUCT   = NO
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = NO
 EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
@@ -58,11 +60,11 @@ HIDE_IN_BODY_DOCS      = NO
 INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = NO
 HIDE_SCOPE_NAMES       = NO
-SHOW_INCLUDE_FILES     = YES
+SHOW_INCLUDE_FILES     = NO
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
-SORT_BRIEF_DOCS        = NO
+SORT_BRIEF_DOCS        = YES
-SORT_BY_SCOPE_NAME     = NO
+SORT_BY_SCOPE_NAME     = YES
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
@@ -80,12 +82,14 @@ WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = "$file:$line: $text "
+WARN_FORMAT            = "$file:$line: $text  "
 WARN_LOGFILE           = 
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../
+INPUT                  = ../include/ \
+                         ../code/ \
+                         ../doc/
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cc \
@@ -131,7 +135,7 @@ FILTER_SOURCE_FILES    = NO
 #---------------------------------------------------------------------------
 SOURCE_BROWSER         = YES
 INLINE_SOURCES         = NO
-STRIP_CODE_COMMENTS    = NO
+STRIP_CODE_COMMENTS    = YES
 REFERENCED_BY_RELATION = NO
 REFERENCES_RELATION    = NO
 REFERENCES_LINK_SOURCE = YES
@@ -147,7 +151,7 @@ IGNORE_PREFIX          =
 # configuration options related to the HTML output
 #---------------------------------------------------------------------------
 GENERATE_HTML          = YES
-HTML_OUTPUT            = html
+HTML_OUTPUT            = lib_html
 HTML_FILE_EXTENSION    = .html
 HTML_HEADER            = 
 HTML_FOOTER            = 

include/aiPostProcess.h

@@ -51,7 +51,7 @@ extern "C" {
 /** Defines the flags for all possible post processing steps. */
 enum aiPostProcessSteps
 {
-	/** Calculates the binormals and tangents for the imported meshes. Does nothing
+	/** Calculates the tangents and bitangents for the imported meshes. Does nothing
 	 * if a mesh does not have normals. You might want this post processing step to be
 	 * executed if you plan to use tangent space calculations such as normal mapping 
 	 * applied to the meshes.
@@ -66,10 +66,10 @@ enum aiPostProcessSteps
 
 	/** Converts all the imported data to a left-handed coordinate space such as 
 	 * the DirectX coordinate system. By default the data is returned in a right-handed
-	 * coordinate space which for example OpenGL preferres. In this space, +X points to the
+	 * coordinate space which for example OpenGL prefers. In this space, +X points to the
-	 * right, +Y points upwards and +Z points to the viewer. In the DirectX coordinate space
+	 * right, +Y points towards the viewer and and +Z points upwards. In the DirectX 
-	 * +X points to the right, +Y points upwards and +Z points away from the viewer 
+   * coordinate space +X points to the right, +Y points upwards and +Z points 
-	 * into the screen.
+   * away from the viewer.
 	 */
 	aiProcess_ConvertToLeftHanded = 4,
 
@@ -80,14 +80,12 @@ enum aiPostProcessSteps
 	 */
 	aiProcess_Triangulate = 8,
 
-
 	/** Omits all normals found in the file. This can be used together
 	 * with either the aiProcess_GenNormals or the aiProcess_GenSmoothNormals
 	 * flag to force the recomputation of the normals.
 	 */
 	aiProcess_KillNormals = 0x10,
 
-
 	/** Generates normals for all faces of all meshes. The normals are shared
 	* between the three vertices of a face. This is ignored
 	* if normals are already existing. This flag may not be specified together
@@ -95,14 +93,12 @@ enum aiPostProcessSteps
 	*/
 	aiProcess_GenNormals = 0x20,
 
-
 	/** Generates smooth normals for all vertices in the mesh. This is ignored
 	* if normals are already existing. This flag may not be specified together
 	* with aiProcess_GenNormals
 	*/
 	aiProcess_GenSmoothNormals = 0x40,
 
-
 	/** Splits large meshes into submeshes
 	* This is quite useful for realtime rendering where the number of vertices
 	* is usually limited by the video driver.