From 32b466941beb1d041eaad84cd2be0b697d31fcfb Mon Sep 17 00:00:00 2001
From: Kim Kulling <kim.kulling@googlemail.com>
Date: Fri, 6 Apr 2018 12:01:22 +0200
Subject: [PATCH] Add missig docs and fix some small review findings.

---
 code/ScenePrivate.h                    | 32 ++++++++++-----
 code/simd.cpp                          | 54 +++++++++++++-------------
 code/simd.h                            |  2 +
 test/unit/AbstractImportExportBase.cpp |  2 +-
 4 files changed, 53 insertions(+), 37 deletions(-)

diff --git a/code/ScenePrivate.h b/code/ScenePrivate.h
index a09d8784b..6a44def2c 100644
--- a/code/ScenePrivate.h
+++ b/code/ScenePrivate.h
@@ -42,22 +42,24 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 /** @file Stuff to deal with aiScene::mPrivate
  */
+#pragma once
 #ifndef AI_SCENEPRIVATE_H_INCLUDED
 #define AI_SCENEPRIVATE_H_INCLUDED
 
 #include <assimp/scene.h>
 
-namespace Assimp    {
+namespace Assimp {
 
+// Forward declarations
 class Importer;
 
 struct ScenePrivateData {
-
     ScenePrivateData()
-        : mOrigImporter()
-        , mPPStepsApplied()
-        , mIsCopy()
-    {}
+    : mOrigImporter( nullptr )
+    , mPPStepsApplied( 0 )
+    , mIsCopy( false ) {
+        // empty
+    }
 
     // Importer that originally loaded the scene though the C-API
     // If set, this object is owned by this private data instance.
@@ -75,14 +77,24 @@ struct ScenePrivateData {
 };
 
 // Access private data stored in the scene
-inline ScenePrivateData* ScenePriv(aiScene* in) {
+inline
+ScenePrivateData* ScenePriv(aiScene* in) {
+    ai_assert( nullptr != in );
+    if ( nullptr == in ) {
+        return nullptr;
+    }
     return static_cast<ScenePrivateData*>(in->mPrivate);
 }
 
-inline const ScenePrivateData* ScenePriv(const aiScene* in) {
+inline
+const ScenePrivateData* ScenePriv(const aiScene* in) {
+    ai_assert( nullptr != in );
+    if ( nullptr == in ) {
+        return nullptr;
+    }
     return static_cast<const ScenePrivateData*>(in->mPrivate);
 }
 
-}
+} // Namespace Assimp
 
-#endif
+#endif // AI_SCENEPRIVATE_H_INCLUDED
diff --git a/code/simd.cpp b/code/simd.cpp
index 9c86cb970..bd951bffa 100644
--- a/code/simd.cpp
+++ b/code/simd.cpp
@@ -43,34 +43,36 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include "simd.h"
 
 namespace Assimp {
-    bool CPUSupportsSSE2() {
+
+bool CPUSupportsSSE2() {
 #if defined(__x86_64__) || defined(_M_X64)
-        //* x86_64 always has SSE2 instructions */
-        return true;
+    //* x86_64 always has SSE2 instructions */
+    return true;
 #elif defined(__GNUC__) && defined(i386)
-        // for GCC x86 we check cpuid
-        unsigned int d;
-        __asm__(
-            "pushl %%ebx\n\t"
-            "cpuid\n\t"
-            "popl %%ebx\n\t"
-            : "=d" ( d )
-            :"a" ( 1 ) );
-        return ( d & 0x04000000 ) != 0;
+    // for GCC x86 we check cpuid
+    unsigned int d;
+    __asm__(
+        "pushl %%ebx\n\t"
+        "cpuid\n\t"
+        "popl %%ebx\n\t"
+        : "=d" ( d )
+        :"a" ( 1 ) );
+    return ( d & 0x04000000 ) != 0;
 #elif (defined(_MSC_VER) && defined(_M_IX86))
-        // also check cpuid for MSVC x86
-        unsigned int d;
-        __asm {
-            xor     eax, eax
-            inc eax
-            push ebx
-            cpuid
-            pop ebx
-            mov d, edx
-        }
-        return ( d & 0x04000000 ) != 0;
-#else
-        return false;
-#endif
+    // also check cpuid for MSVC x86
+    unsigned int d;
+    __asm {
+        xor     eax, eax
+        inc eax
+        push ebx
+        cpuid
+        pop ebx
+        mov d, edx
     }
+    return ( d & 0x04000000 ) != 0;
+#else
+    return false;
+#endif
 }
+
+} // Namespace Assimp
diff --git a/code/simd.h b/code/simd.h
index 8fe2bb851..19117569d 100644
--- a/code/simd.h
+++ b/code/simd.h
@@ -46,6 +46,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 namespace Assimp {
 
+/// @brief  Checks if the platform supports SSE2 optimization
+/// @return true, if SSE2 is supported. false if SSE2 is not supported.
 bool ASSIMP_API CPUSupportsSSE2();
 
 } // Namespace Assimp
diff --git a/test/unit/AbstractImportExportBase.cpp b/test/unit/AbstractImportExportBase.cpp
index f75ba4ea2..c09ec0fd7 100644
--- a/test/unit/AbstractImportExportBase.cpp
+++ b/test/unit/AbstractImportExportBase.cpp
@@ -45,5 +45,5 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 using namespace ::Assimp;
 
 AbstractImportExportBase::~AbstractImportExportBase() {
-        // empty
+    // empty
 }