diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PxShared/src/foundation/doc | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PxShared/src/foundation/doc')
| -rw-r--r-- | PxShared/src/foundation/doc/PsFoundation.chm | bin | 0 -> 548596 bytes | |||
| -rw-r--r-- | PxShared/src/foundation/doc/Readme.txt | 18 | ||||
| -rwxr-xr-x | PxShared/src/foundation/doc/create_docs.cmd | 7 | ||||
| -rw-r--r-- | PxShared/src/foundation/doc/docs.doxyfile | 13 |
4 files changed, 38 insertions, 0 deletions
diff --git a/PxShared/src/foundation/doc/PsFoundation.chm b/PxShared/src/foundation/doc/PsFoundation.chm Binary files differnew file mode 100644 index 00000000..df3c07fd --- /dev/null +++ b/PxShared/src/foundation/doc/PsFoundation.chm diff --git a/PxShared/src/foundation/doc/Readme.txt b/PxShared/src/foundation/doc/Readme.txt new file mode 100644 index 00000000..88e11894 --- /dev/null +++ b/PxShared/src/foundation/doc/Readme.txt @@ -0,0 +1,18 @@ +This is the 'NVIDIA Shared' foundation library. + +This code should not ever appear in any public headers or interfaces. + +This library is primarily a platform abstraction layer. + +It contains code to handle mutexes, atomic operations, etc. + +It also handles some SIMD data types. + +It provides math utility functions. + +It implements a number of common container classes. + +It manages trapping all memory allocations. + +All projects should leverage against this foundation library to +perform these common functions. diff --git a/PxShared/src/foundation/doc/create_docs.cmd b/PxShared/src/foundation/doc/create_docs.cmd new file mode 100755 index 00000000..4691d7d2 --- /dev/null +++ b/PxShared/src/foundation/doc/create_docs.cmd @@ -0,0 +1,7 @@ +set DOXYGEN_DIR=..\..\..\..\..\..\..\devrel\GameWorks\BuildTools\doxygen-win\bin +set HTMLHELP_DIR=..\..\..\..\..\..\..\devrel\GameWorks\BuildTools\HTMLHelpWorkshop + +%DOXYGEN_DIR%\doxygen.exe docs.doxyfile +cd html +..\%HTMLHELP_DIR%\hhc.exe index.hhp +cd .. diff --git a/PxShared/src/foundation/doc/docs.doxyfile b/PxShared/src/foundation/doc/docs.doxyfile new file mode 100644 index 00000000..624a44f6 --- /dev/null +++ b/PxShared/src/foundation/doc/docs.doxyfile @@ -0,0 +1,13 @@ +# Doxyfile 1.5.8 + +PROJECT_NAME = "NVIDIA(R) PsFoundation Reference" +#ENABLED_SECTIONS = PHYSICS_SDK_PAGES +WARN_LOGFILE = PsFoundation.err +INPUT = ../include ../include/windows ../src ../src/windows +EXTRACT_ALL = YES +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +GENERATE_HTMLHELP = YES +HTML_OUTPUT = html/ +CHM_FILE = ../PsFoundation.chm +TOC_EXPAND = YES |