Skip to content

Commit

Permalink
Change doc version number to 1.1, rebuild CHMs.
Browse files Browse the repository at this point in the history
Add missing docs for the newer assimpcmd utilities.
(fix path to html workshop in doxygen scripts to make 'em work on my machine :-)

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@642 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
  • Loading branch information
aramis_acg committed Apr 4, 2010
1 parent 1d0e6b7 commit 418033e
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 4 deletions.
Binary file modified doc/AssimpCmdDoc_Html/AssimpCmdDoc.chm
Binary file not shown.
Binary file modified doc/AssimpDoc_Html/AssimpDoc.chm
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Assimp
PROJECT_NUMBER = r590
PROJECT_NUMBER = "v1.1 (April 2010)"
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
Expand Down Expand Up @@ -172,7 +172,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
GENERATE_HTMLHELP = YES
CHM_FILE = AssimpDoc.chm
HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe"
HHC_LOCATION = "C:\Program Files (x86)\HTML Help Workshop/hhc.exe"
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
Expand Down
4 changes: 2 additions & 2 deletions doc/Doxyfile_Cmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Assimp Command Line Tools
PROJECT_NUMBER = r400
PROJECT_NUMBER = "v1.1 (April 2010)"
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
Expand Down Expand Up @@ -170,7 +170,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
GENERATE_HTMLHELP = YES
CHM_FILE = AssimpCmdDoc.chm
HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe"
HHC_LOCATION = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
Expand Down
75 changes: 75 additions & 0 deletions doc/dox_cmd.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ The following commands are available:
<td><b>@link extract extract @endlink</b></td>
<td>Extract an embedded texture image</td>
</tr>
<tr>
<td><b>@link iinfo info @endlink</b></td>
<td>Load a model and print basic statistics</td>
</tr>
<tr>
<td><b>@link cmpdump cmpdump @endlink</b></td>
<td>Regression checking tool</td>
</tr>
</table>
If you use assimp's command line frequently, consider adding assimp to your PATH
Expand All @@ -66,6 +74,73 @@ Display the version/revision of Assimp used.
Display a really helpful text.
*/

//----------------------------------------------------------------------------------------------
// ASSIMP INFO

/**
@page iinfo 'info'-Command
Load a model file and print basic statistics. Full postprocessing is applied unless the <tt>-r</tt> switch is specified. Sample output (<tt>assimp info ./test/models/3DS/mar_rifle.3ds</tt>):
@verbatim
Launching model import ... OK
Validating postprocessing flags ... OK
Importing file ... OK
import took approx. 0.02400 seconds
Memory consumption: 69444 B
Nodes: 2
Maximum depth 2
Meshes: 1
Animations: 0
Textures (embed.): 0
Materials: 1
Cameras: 0
Lights: 0
Vertices: 843
Faces: 572
Bones: 0
Animation Channels: 0
Primitive Types: triangles
Average faces/mesh 572
Average verts/mesh 843
Minimum point (-3.522588 -11.573204 -40.340359)
Maximum point (3.522622 30.196556 75.941292)
Center point (0.000017 9.311676 17.800467)
Named Materials:
'mat1'
Texture Refs:
'm_rifl.bmp'
Node hierarchy:
'<3DSRoot>', meshes: 0
-- 'm_rifle', meshes: 1
<--
@endverbatim
<h3>Syntax:</h3>
@code
assimp info file [-r]
@endcode
<h3>Parameters:</h3>
<p>
<tt>
file<br></tt><br>
Required. Input file.
</p>
<p>
<tt>
-r</tt><br>
Optional. Don't perform any postprocessing. The long form of this parameter is <tt>--raw</tt>.
</p>
*/
//----------------------------------------------------------------------------------------------
// ASSIMP CMPDUMP

Expand Down

0 comments on commit 418033e

Please sign in to comment.