From fb18ee8f05ff36f517ef2248539fda8a79c33f0e Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@qt.io>
Date: Wed, 11 Oct 2017 12:14:52 +0200
Subject: Doc: add doc to undocumented classes qt3d

Fbxgeometryloader
Plygeometryloader

Change-Id: Iace5ec78521d96386c1c2171195deba7ad6b5597
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
---
 .../geometryloaders/default/plygeometryloader.cpp  | 58 ++++++++++++++++++++++
 .../geometryloaders/fbx/fbxgeometryloader.cpp      | 30 ++++++++---
 2 files changed, 82 insertions(+), 6 deletions(-)

diff --git a/src/plugins/geometryloaders/default/plygeometryloader.cpp b/src/plugins/geometryloaders/default/plygeometryloader.cpp
index a51c991af..1e50dbfeb 100644
--- a/src/plugins/geometryloaders/default/plygeometryloader.cpp
+++ b/src/plugins/geometryloaders/default/plygeometryloader.cpp
@@ -217,6 +217,11 @@ bool PlyGeometryLoader::doLoad(QIODevice *ioDev, const QString &subMesh)
     return true;
 }
 
+/*!
+    Read and parse the header of the PLY format file.
+    Returns \c false if one of the lines is wrongly
+    formatted.
+*/
 bool PlyGeometryLoader::parseHeader(QIODevice *ioDev)
 {
     Format format = FormatUnknown;
@@ -424,6 +429,59 @@ bool PlyGeometryLoader::parseMesh(QIODevice *ioDev)
     return true;
 }
 
+/*!
+   \enum Qt3DRender::PlyGeometryLoader::DataType
+
+   Specifies the data type specified in the parsed file.
+
+   \value Int8
+   \value Uint8
+   \value Int16
+   \value Uint16
+   \value Int32
+   \value Uint32
+   \value Float32
+   \value Float64
+   \value TypeList
+   \value TypeUnknown
+*/
+/*!
+    \enum Qt3DRender::PlyGeometryLoader::Format
+
+    Specifies the format mentioned in the header of the parsed file.
+
+    \value FormatAscii
+    \value FormatBinaryLittleEndian
+    \value FormatBinaryBigEndian
+    \value FormatUnknown
+*/
+/*!
+    \enum Qt3DRender::PlyGeometryLoader::ElementType
+
+    Specifies the element type mentioned in the header of the file.
+
+    \value ElementVertex
+    \value ElementFace
+    \value ElementUnknown
+
+*/
+/*!
+    \enum Qt3DRender::PlyGeometryLoader::PropertyType
+
+    Specifies the property type from the PLY format file that has been loaded.
+
+    \value PropertyVertexIndex Property name in header is \c vertex_index
+    \value PropertyX Property name in header is \c X
+    \value PropertyY Property name in header is \c Y
+    \value PropertyZ Property name in header is \c Z
+    \value PropertyNormalX Property name in header is \c NormalX
+    \value PropertyNormalY Property name in header is \c NormalY
+    \value PropertyNormalZ Property name in header is \c NormalZ
+    \value PropertyTextureU Property name in header is \c TextureU
+    \value PropertyTextureV Property name in header is \c TextureV
+    \value PropertyUnknown Property name in header is unknown
+
+*/
 } // namespace Qt3DRender
 
 QT_END_NAMESPACE
diff --git a/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp b/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp
index 7b1b8e4ee..10870dde8 100644
--- a/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp
+++ b/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp
@@ -234,12 +234,20 @@ FbxGeometryLoader::~FbxGeometryLoader()
         m_manager->Destroy();
 }
 
-QGeometry *FbxGeometryLoader::geometry() const
+/*!
+    Give the list of attributes that can be used to render
+    a 3D form.
+    Returns a pointer to the geometry object.
+*/
+QGeometry *Qt3DRender::FbxGeometryLoader::geometry() const
 {
     return m_geometry;
 }
 
-bool FbxGeometryLoader::load(QIODevice *ioDev, const QString &subMesh)
+/*!
+    Load the specified \a subMesh using device \a ioDev.
+*/
+bool Qt3DRender::FbxGeometryLoader::load(QIODevice *ioDev, const QString &subMesh)
 {
     if (m_scene)
         m_scene->Destroy();
@@ -310,6 +318,10 @@ bool FbxGeometryLoader::load(QIODevice *ioDev, const QString &subMesh)
     return wasImported;
 }
 
+/*!
+    Traverse the node hierarchy and process the children of each
+    node.
+*/
 void FbxGeometryLoader::recurseNodes()
 {
     Q_ASSERT(m_scene);
@@ -323,8 +335,12 @@ void FbxGeometryLoader::recurseNodes()
             processNode(node->GetChild(i));
     }
 }
-
-void FbxGeometryLoader::processNode(FbxNode *node)
+/*!
+    If the parameter \a node has the attribute eMesh,
+    process the Mesh. If not, process the children
+    of that node.
+*/
+void Qt3DRender::FbxGeometryLoader::processNode(FbxNode *node)
 {
     auto attr = node->GetNodeAttribute();
     if (!attr)
@@ -347,8 +363,10 @@ void FbxGeometryLoader::processNode(FbxNode *node)
     for (int i = 0; i < node->GetChildCount(); ++i)
         processNode(node->GetChild(i));
 }
-
-void FbxGeometryLoader::processMesh(FbxMesh *mesh)
+/*!
+    Process all vertices of the specified \a mesh.
+*/
+void Qt3DRender::FbxGeometryLoader::processMesh(FbxMesh *mesh)
 {
     const int normalCount = mesh->GetElementNormalCount();
     const int polygonCount = mesh->GetPolygonCount();
-- 
cgit v1.2.3