Documentation update

Author: eprikazchikov

README.md

@@ -1,23 +1,37 @@
 ## Thunder Engine
-Thunder Engine is free for all purposes an open-source multi-functional lightweight game engine for creating 2D and 3D games. It provides a wide range of frameworks and tools. So developers can focus on the creation, and the Thunder Engine will do the routine.
+
+Thunder Engine is free for all purposes an open-source multi-functional lightweight game engine for creating 2D and 3D games.
+It provides a basic framework and extensible tools.
+So developers can focus on the creation, and the Thunder Engine will do the routine.
 
 #### Build Status
+
 ![Build Status](https://github.com/thunder-engine/thunder/actions/workflows/main.yml/badge.svg)
+
 #### Code Quality Status
+
 [![Coverity Status](https://img.shields.io/coverity/scan/15068.svg)](https://scan.coverity.com/projects/eprikazchikov-thunder)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/8874a5f2ddb84eb1bbaebe00f5562c23)](https://www.codacy.com/gh/thunder-engine/thunder/dashboard?utm_source=github.com&utm_medium=referral&utm_content=thunder-engine/thunder&utm_campaign=Badge_Grade)
 [![Translation Status](https://hosted.weblate.org/widgets/thunder-engine/-/editor-translation/svg-badge.svg)](https://hosted.weblate.org/engage/thunder-engine/)
 
 ### About
 
-The main ideology of project is to create the modular engine to give developers an ability to exclude modules which they are not using in their project to keep their projects lightweight. API of Thunder Engine is also allowing to create own modules to use them in your games.
+The main ideology of project is to create the modular engine.
+It will give developers an ability to exclude modules which they are not using in their project to keep their projects lightweight.
+API of Thunder Engine is also allowing to create own modules to use them in your games or in game editor.
 
 ![Screenshot of Thunder Engine](https://raw.githubusercontent.com/thunder-engine/thunder/master/doc/media/ScreenShot01.png)
 
 [![Discord](https://img.shields.io/discord/466924817359175681.svg?logo=discord)](https://discord.gg/k8qsJxnw4Q)
 [![Gitter chat](https://badges.gitter.im/Thunder-Engine/gitter.png)](https://gitter.im/Thunder-Engine)
 
+### Getting the Engine
+
+To download the release version use the [Releases page](https://github.com/thunder-engine/thunder/releases).
+For other options please follow a [build instruction](https://doc.thunderengine.org/en/latest/basics/source.html).
+
 #### Features
+
 - Cross-platform (Windows, Linux, macOS, Android, iOS, tvOS)
 - Rendering System Based on Physical Principles
 - Scripts supported by AngelScipt engine
@@ -26,10 +40,9 @@ The main ideology of project is to create the modular engine to give developers
 Please find a complete [list of features](https://doc.thunderengine.org/en/latest/basics/features.html).
 
 #### Have a question or an idea?
-I'm always open to new ideas and you can always ask a question or you can [create a ticket](https://github.com/thunder-engine/thunder/issues/new/choose)
+
+I'm always open to new ideas and you can always ask a question or you can [create a ticket](https://github.com/thunder-engine/thunder/issues/new/choose).
 
 #### Contributing
-Would like to help to project? Please read [this](CONTRIBUTING.md).
 
-### Getting the Engine
-Please follow a [build instruction](https://doc.thunderengine.org/en/latest/basics/source.html)
+Would like to help to project? Please read [this](CONTRIBUTING.md).

engine/src/components/actor.cpp

@@ -205,6 +205,13 @@ class ActorPrivate : public Resource::IObserver {
     The Transform component must persist constantly and you shoudn't remove it.
 */
 
+/*!
+    \enum Actor::HideFlags
+
+    \value ENABLE \c This Actor can be visible on the screen and can be updated in the game cycle.
+    \value SELECTABLE \c This Actor can be selected in the Editor.
+*/
+
 Actor::Actor() :
         p_ptr(new ActorPrivate(this)) {
 
@@ -237,13 +244,17 @@ void Actor::setEnabled(const bool enabled) {
 
     setHierarchyEnabled(enabled);
 }
-
+/*!
+    Returns a set of Actor::HideFlags applied to this Actor.
+*/
 int Actor::hideFlags() const {
     PROFILE_FUNCTION();
 
     return p_ptr->m_flags;
 }
-
+/*!
+    Applies a new set of Actor::HideFlags flags to this Actor.
+*/
 void Actor::setHideFlags(int flags) {
     PROFILE_FUNCTION();
 

engine/src/components/camera.cpp

@@ -327,8 +327,17 @@ array<Vector3, 8> Camera::frustumCorners(const Camera &camera) {
 }
 /*!
     Returns frustum corners with provided parameters.
+    This function accepts a list of parameters:
+    \a ortho is a flag that points orthographic or perspective camera.
+    \a sigma is an angle of frustum or ortho size in the case of an orthographic camera.
+    \a ratio is an aspect ratio.
+    \a position of the frustum in world space.
+    \a rotation of frustum in world space.
+    \a nearPlane clipping plane.
+    \a farPlane clipping plane.
 */
-array<Vector3, 8> Camera::frustumCorners(bool ortho, float sigma, float ratio, const Vector3 &position, const Quaternion &rotation, float nearPlane, float farPlane) {
+array<Vector3, 8> Camera::frustumCorners(bool ortho, float sigma, float ratio, const Vector3 &position,
+                                         const Quaternion &rotation, float nearPlane, float farPlane) {
     float nh;
     float fh;
     float nw;

engine/src/module.cpp

@@ -11,24 +11,9 @@
 */
 
 /*!
-    \enum Module::PluginTypes
+    \fn const char *Module::metaInfo() const
 
-    \value SYSTEM \c Module provides a system.
-    \value EXTENSION \c Module provides a set of components.
-    \value CONVERTER \c Module provides a converter for assets (only in Editor).
-    \value EDITOR \c Module provides an asset editor (only in Editor).
-*/
-
-/*!
-    \fn const char *Module::description() const
-
-    Returns a short description of the module.
-*/
-
-/*!
-    \fn const char *Module::version() const
-
-    Return an internal version of the module as a string.
+    Returns a meta information in JSON format.
 */
 
 /*!
@@ -48,9 +33,3 @@
 
     Returns a module's asset editor with given \a name if present; otherwise returns nullptr.
 */
-
-/*!
-    \fn StringList Module::components() const
-
-    Returns a list of provided components.
-*/

engine/src/resources/resource.cpp

@@ -85,7 +85,7 @@ Resource::ResourceState Resource::state() const {
 }
 
 /*!
-    Switches the current state to a new state for the resource.
+    Switches the current state to a new \a state for the resource.
 */
 void Resource::switchState(ResourceState state) {
     switch(state) {

engine/src/resources/texture.cpp

@@ -73,6 +73,16 @@ class TexturePrivate {
     \value Trilinear \c Texture samples are averaged and also interpolated from adjacent mipmap levels.
 */
 
+/*!
+    \typedef Texture::Sides
+    \internal
+*/
+
+/*!
+    \typedef Texture::Surface
+    \internal
+*/
+
 Texture::Texture() :
         p_ptr(new TexturePrivate) {
 
@@ -116,7 +126,9 @@ void Texture::loadUserData(const VariantMap &data) {
         }
     }
 }
-
+/*!
+    \internal
+*/
 VariantMap Texture::saveUserData() const {
     VariantMap result;
 

thirdparty/next/src/core/objectsystem.cpp

@@ -33,6 +33,10 @@ static ObjectSystem::GroupMap   s_Groups;
 
     \sa objectCreate()
 */
+/*!
+    \typedef ObjectSystem::FactoryPair
+    \internal
+*/
 /*!
     \fn template<typename T> void ObjectSystem::factoryAdd(const string &group, const MetaObject *meta)