Просмотр исходного кода

Added missing plugin documentation
Alphabetized documentation groups

BearishSun 9 лет назад
Родитель
Сommit
4036f8a11b

+ 3 - 1
Documentation/Doxygen/Native.doxyconfig

@@ -792,7 +792,9 @@ INPUT                  = ../../Source/BansheeUtility/Include \
                          ../../Source/BansheeMono/Include \
                          ../../Source/SBansheeEngine/Include \
                          ../../Source/SBansheeEditor/Include \
-                         ../Manuals/Native
+                         ../Manuals/Native \
+                         ../../Source/BansheeFMOD/Include \
+                         ../../Source/BansheeOpenAudio/Include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

+ 28 - 28
Source/BansheeCore/Include/BsCorePrerequisites.h

@@ -13,14 +13,22 @@
  *  @{
  */
 
-/** @defgroup Audio Audio
- *	Audio clips, 3D sound and music reproduction.
+/** @defgroup Animation Animation
+ *	%Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
  */
 
-/** @defgroup Animation Animation
- *	Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
+/** @defgroup Application-Core Application
+ *  Entry point into the application and other general functionality.
  */
 
+/** @defgroup Audio Audio
+ *	%Audio clips, 3D sound and music reproduction.
+ */
+
+/** @defgroup Components-Core Components
+  *	Built-in components (elements that may be attached to scene objects).
+  */
+
 /** @defgroup CoreThread Core thread
  *	Core objects and interaction with the core (rendering) thread.
  */
@@ -41,6 +49,10 @@
  *	Materials, shaders and related functionality.
  */
 
+/** @defgroup Physics Physics
+ *	%Physics system: colliders, triggers, rigidbodies, joints, scene queries, etc.
+ */
+
  /** @defgroup Profiling Profiling
   *	Measuring CPU and GPU execution times and memory usage.
   */
@@ -75,18 +87,6 @@
  *  Various utility methods and types used by the core layer.
  */
 
-/** @defgroup Application-Core Application
- *  Entry point into the application and other general functionality.
- */
-
-/** @defgroup Components-Core Components
-  *	Built-in components (elements that may be attached to scene objects).
-  */
-
-/** @defgroup Physics Physics
- *	%Physics system: colliders, triggers, rigidbodies, joints, scene queries, etc.
- */
-
 /** @} */
 /** @} */
 
@@ -94,6 +94,14 @@
  *  @{
  */
 
+/** @defgroup Animation-Internal Animation
+ *	Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
+ */
+
+/** @defgroup Audio-Internal Audio
+ *	Audio clips, 3D sound and music reproduction.
+ */
+
 /** @defgroup Internal-Core Core
  *	Second lowest layer that provides core engine functionality and abstract interfaces for various systems.
  *  @{
@@ -119,6 +127,10 @@
  *	Materials, shaders and related functionality.
  */
 
+/** @defgroup Physics-Internal Physics
+ *	Physics system: colliders, triggers, rigidbodies, joints, scene queries, etc.
+ */
+
 /** @defgroup Platform-Internal Platform
  *	Interface for interacting with the platform (OS).
  */
@@ -131,10 +143,6 @@
   *	Interface for interacting with the render API (DirectX, OpenGL, etc.).
   */
 
-/** @defgroup Animation-Internal Animation
- *	Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
- */
-
 /** @defgroup Renderer-Internal Renderer
   *	Abstract interface and helper functionality for rendering scene objects.
   */
@@ -155,14 +163,6 @@
  *  Various utility methods and types used by the core layer.
  */
 
-/** @defgroup Physics-Internal Physics
- *	Physics system: colliders, triggers, rigidbodies, joints, scene queries, etc.
- */
-
-/** @defgroup Audio-Internal Audio
- *	Audio clips, 3D sound and music reproduction.
- */
-
 /** @} */
 /** @} */
 

+ 14 - 14
Source/BansheeEditor/Include/BsEditorPrerequisites.h

@@ -8,6 +8,18 @@
  *  @{
  */
 
+/** @defgroup Application-Editor Application
+ *  Entry point into the editor application.
+ */
+
+/** @defgroup Build Build
+  *	Building (publishing) the game from within the editor.
+  */
+
+/** @defgroup CodeEditor CodeEditor
+  *	Integration of the Banshee Editor with external code editors.
+  */
+
 /** @defgroup Editor Editor
  *	Functionality specific to the Banshee Editor.
  *  @{
@@ -17,22 +29,10 @@
  *  Creating, managing and interacting with editor windows.
  */
 
-/** @defgroup Utility-Editor Utility
- *  Various utility methods and types used by the editor layer.
- */
-
 /** @defgroup GUI-Editor GUI
   *	Editor specific GUI elements.
   */
 
-/** @defgroup Build Build
-  *	Building (publishing) the game from within the editor.
-  */
-
-/** @defgroup CodeEditor CodeEditor
-  *	Integration of the Banshee Editor with external code editors.
-  */
-
 /** @defgroup Handles Handles
   *	Creating and interacting with handles (scene tools).
   */
@@ -63,8 +63,8 @@
  *  Undoing and redoing actions within the editor.
  */
 
-/** @defgroup Application-Editor Application
- *  Entry point into the editor application.
+/** @defgroup Utility-Editor Utility
+ *  Various utility methods and types used by the editor layer.
  */
 
 /** @} */

+ 12 - 12
Source/BansheeEngine/Include/BsPrerequisites.h

@@ -17,6 +17,10 @@
   *	Two dimensional geometry (sprites).
   */
 
+/** @defgroup Application-Engine Application
+ *  Entry point into the application.
+ */
+
 /** @defgroup Components Components
   *	Built-in components.
   */
@@ -29,26 +33,22 @@
  *	User input (mouse, keyboard, gamepad, etc.).
  */
 
-/** @cond RTTI */
-/** @defgroup RTTI-Impl-Engine RTTI types
- *  Types containing RTTI for specific classes.
+/** @defgroup Platform-Engine Platform
+ *  %Platform specific functionality.
  */
-/** @endcond */
 
 /** @defgroup Resources-Engine Resources
   *	Builtin engine resource types and a manager for such resources.
   */
 
-/** @defgroup Utility-Engine Utility
- *  Various utility methods and types used by the engine layer.
- */
-
-/** @defgroup Platform-Engine Platform
- *  %Platform specific functionality.
+/** @cond RTTI */
+/** @defgroup RTTI-Impl-Engine RTTI types
+ *  Types containing RTTI for specific classes.
  */
+/** @endcond */
 
-/** @defgroup Application-Engine Application
- *  Entry point into the application.
+/** @defgroup Utility-Engine Utility
+ *  Various utility methods and types used by the engine layer.
  */
 
 /** @} */

+ 24 - 24
Source/BansheeUtility/Include/BsPrerequisitesUtil.h

@@ -14,22 +14,6 @@
  *  @{
  */
 
-/** @defgroup Math Math
- *	Variety of general purpose math functionality.
- */
-
-/** @defgroup RTTI RTTI
- *  Run-time type information defining and querying.
- */
-
-/** @defgroup Serialization Serialization
- *  Serialization and deserialization of native objects.
- */
-
-/** @defgroup Memory Memory
- *  Allocators, deallocators and memory manipulation.
- */
-
 /** @defgroup Containers Containers
  *  Templated commonly used containers.
  */
@@ -54,16 +38,20 @@
  *  Manipulating images.
  */
 
-/** @defgroup String String
- *  String manipulation.
+/** @defgroup Math Math
+ *	Variety of general purpose math functionality.
  */
 
-/** @defgroup Testing Testing
- *  Running unit tests.
+/** @defgroup Memory Memory
+ *  Allocators, deallocators and memory manipulation.
  */
 
-/** @defgroup Threading Threading
- *  Thread manipulation and synchronization.
+/** @defgroup Platform-Utility Platform
+ *  %Platform specific functionality.
+ */
+
+/** @defgroup RTTI RTTI
+ *  Run-time type information defining and querying.
  */
 
 /** @cond RTTI */
@@ -72,8 +60,20 @@
  */
 /** @endcond */
 
-/** @defgroup Platform-Utility Platform
- *  %Platform specific functionality.
+/** @defgroup Serialization Serialization
+ *  Serialization and deserialization of native objects.
+ */
+
+/** @defgroup String String
+ *  String manipulation.
+ */
+
+/** @defgroup Testing Testing
+ *  Running unit tests.
+ */
+
+/** @defgroup Threading Threading
+ *  Thread manipulation and synchronization.
  */
 
 /** @} */

+ 12 - 15
Source/MBansheeEditor/General/Program.cs

@@ -10,6 +10,10 @@ namespace BansheeEditor
      *  @{
      */
 
+    /** @defgroup General General 
+     *  Various functionality that doesn't fit into any other category.
+     */
+
     /** @defgroup GUI-Editor GUI 
      *  Editor specific GUI elements.
      */
@@ -18,14 +22,14 @@ namespace BansheeEditor
      *  %Input handling for editor only (not affected by game pauses).
      */
 
-    /** @defgroup General General 
-     *  Various functionality that doesn't fit into any other category.
-     */
-
     /** @defgroup Inspectors Inspectors 
      *  Implementations of inspectors for various engine types.
      */
 
+    /** @defgroup Settings Settings 
+     *  Editor and project settings, and related window.
+     */
+
     /** @defgroup Script Script 
      *  Script code management and compilation.
      */
@@ -47,6 +51,10 @@ namespace BansheeEditor
      *  @{
      */
 
+    /** @defgroup AnimationEditor Animation Editor 
+     *  Animation editor window and related functionality.
+     */
+
     /** @defgroup Build Build 
      *  Build editor window and build manager.
      */
@@ -64,11 +72,6 @@ namespace BansheeEditor
      *  @{
      */
 
-    /** @defgroup AnimationEditor Animation Editor 
-     *  Animation editor window and related functionality.
-     *  @{
-     */
-
     /** @defgroup Gizmos Gizmos 
      *  Interface for creating custom gizmos.
      */
@@ -78,13 +81,7 @@ namespace BansheeEditor
      */
 
     /** @} */
-
-    /** @defgroup Settings Settings 
-     *  Editor and project settings, and related window.
-     */
-
     /** @} */
-
     /** @} */
 
     /** @cond Interop */

+ 12 - 12
Source/MBansheeEngine/Interop/Program.cs

@@ -11,6 +11,14 @@ namespace BansheeEngine
      *  @{
      */
 
+    /** @defgroup Animation Animation
+     *	Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
+     */
+
+    /** @defgroup Audio Audio
+     *  Audio clips, 3D sound and music reproduction.
+     */
+
     /** @defgroup GUI-Engine GUI 
      *  Graphical user interface, including elements, styles and localization.
      */
@@ -19,13 +27,11 @@ namespace BansheeEngine
      *  %Input (mouse, keyboard, gamepad, etc.).
      */
 
-    /** @defgroup Audio Audio
-     *  Audio clips, 3D sound and music reproduction.
-     */
-
-    /** @defgroup Animation Animation
-     *	Animation clips, skeletal and blend shape animation, animation playback, blending and other features.
+    /** @cond INTEROP */
+    /** @defgroup Interop Interop 
+     *  Glue types that are used for C++/C# interop.
      */
+    /** @endcond */
 
     /** @defgroup Math Math 
      *  Variety of general purpose math functionality.
@@ -35,12 +41,6 @@ namespace BansheeEngine
      *  %Physics system: colliders, triggers, rigidbodies, joints, scene queries, etc.
      */
 
-    /** @cond INTEROP */
-    /** @defgroup Interop Interop 
-     *  Glue types that are used for C++/C# interop.
-     */
-    /** @endcond */
-
     /** @defgroup Rendering Rendering 
      *  Materials, shaders, textures, meshes and components relating to rendering.
      */