diff --git a/doc/AssimpCmdDoc_Html/AssimpCmdDoc.chm b/doc/AssimpCmdDoc_Html/AssimpCmdDoc.chm index 9c47f2125..5179a8447 100644 Binary files a/doc/AssimpCmdDoc_Html/AssimpCmdDoc.chm and b/doc/AssimpCmdDoc_Html/AssimpCmdDoc.chm differ diff --git a/doc/dox_cmd.h b/doc/dox_cmd.h index 22fdbb595..7de5b2946 100644 --- a/doc/dox_cmd.h +++ b/doc/dox_cmd.h @@ -57,15 +57,48 @@ environment. /** @page version 'version'-Command - +Display the version/revision of Assimp used. */ /** @page help 'help'-Command - +Display a really helpful text. */ +//---------------------------------------------------------------------------------------------- +// ASSIMP CMPDUMP + +/** +@page cmpdump 'cmpdump'-Command + +Used for Assimp's internal regression testing. Compare two mini dumps (produced using assimp dump .. -b -s) and +report any differences. In the regression test suite, this facility is used to build a database of +'known-to-be-fine' mini dumps, which are regularly compared against current results to detect regressions. + +

Syntax:

+ +@code +assimp cmpdmp actual expected +@endcode + + +

Parameters:

+ +

+ +actual

+Required. Mini dump now. +

+

+ +expected

+Required. Archived dump from some point in the past. +

+ +*/ + + //---------------------------------------------------------------------------------------------- // ASSIMP DUMP @@ -77,7 +110,7 @@ regression test suite but it could also be useful for other developers to quickl examine the contents of a model. Note that text dumps are not intended to be used as intermediate format, Assimp is not able to read them again, nor is the file format stable or well-defined. It may change with every revision without notice. -Binary dumps (*.assfile) are backward- and forward-compatible. +Binary dumps (*.assbin) are backwards- and forwards-compatible.

Syntax:

@@ -91,8 +124,7 @@ assimp dump [] [-b] [-s] [common parameters]

model

-Required. Relative or absolute path to the input model. A wildcard may be specified. -See the @link wildcard wildcards page @endlink for more information. +Required. Relative or absolute path to the input model.

@@ -168,8 +200,7 @@ assimp extract [] [-t] [-f] [-ba] [-s] [common parameters]

model

-Required. Relative or absolute path to the input model. A wildcard may be specified. -See the @link wildcard wildcards page @endlink for more information. +Required. Relative or absolute path to the input model.