Daniele Bartolini пре 9 година
родитељ
комит
a27c63e56d

+ 3 - 3
docs/doxygen/Doxyfile.doxygen

@@ -32,19 +32,19 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = Crown
+PROJECT_NAME           = Pepper
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.1.13
+PROJECT_NUMBER         = 0.0.23
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Lightweight and flexible cross-platform game engine."
+PROJECT_BRIEF          = "The flexible game engine."
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
 # the documentation. The maximum height of the logo should not exceed 55 pixels

+ 2 - 0
src/core/command_line.h

@@ -10,6 +10,8 @@
 namespace crown
 {
 /// Helper for parsing command line.
+///
+/// @ingroup Core
 struct CommandLine
 {
 	int _argc;

+ 1 - 0
src/core/containers/container_types.h

@@ -11,6 +11,7 @@
 #include "types.h"
 
 /// @defgroup Containers Containers
+/// @ingroup Core
 namespace crown
 {
 /// Dynamic array of POD items.

+ 1 - 0
src/core/error/error.h

@@ -8,6 +8,7 @@
 #include "config.h"
 
 /// @defgroup Error Error
+/// @ingroup Core
 namespace crown
 {
 /// Error management.

+ 1 - 0
src/core/filesystem/filesystem_types.h

@@ -6,6 +6,7 @@
 #pragma once
 
 /// @defgroup Filesystem Filesystem
+/// @ingroup Core
 namespace crown
 {
 class Filesystem;

+ 1 - 0
src/core/json/json_types.h

@@ -9,6 +9,7 @@
 #include "fixed_string.h"
 
 /// @defgroup JSON
+/// @ingroup Core
 namespace crown
 {
 /// Enumerates JSON value types.

+ 1 - 0
src/core/math/math_types.h

@@ -8,6 +8,7 @@
 #include "types.h"
 
 /// @defgroup Math Math
+/// @ingroup Core
 namespace crown
 {
 /// @ingroup Math

+ 0 - 1
src/core/memory/memory.h

@@ -10,7 +10,6 @@
 #include "allocator.h"
 #include <new>
 
-/// @defgroup Memory Memory
 namespace crown
 {
 Allocator& default_allocator();

+ 2 - 0
src/core/memory/memory_types.h

@@ -5,6 +5,8 @@
 
 #pragma once
 
+/// @defgroup Memory Memory
+/// @ingroup Core
 namespace crown
 {
 class Allocator;

+ 1 - 0
src/core/network/network_types.h

@@ -6,6 +6,7 @@
 #pragma once
 
 /// @defgroup Network Network
+/// @ingroup Core
 namespace crown
 {
 struct Socket;

+ 6 - 0
src/core/os.h

@@ -29,8 +29,13 @@
 	#include <android/log.h>
 #endif
 
+/// @defgroup OS OS
+/// @ingroup Core
 namespace crown
 {
+/// Operating system functions.
+///
+/// @ingroup OS
 namespace os
 {
 	inline s64 clocktime()
@@ -63,6 +68,7 @@ namespace os
 #endif
 	}
 
+	/// Suspends execution for @a ms milliseconds.
 	inline void sleep(u32 ms)
 	{
 #if CROWN_PLATFORM_POSIX

+ 1 - 0
src/core/strings/string_types.h

@@ -8,6 +8,7 @@
 #include "container_types.h"
 
 /// @defgroup String String
+/// @ingroup Core
 namespace crown
 {
 struct DynamicString;

+ 1 - 0
src/core/thread/thread.h

@@ -18,6 +18,7 @@
 #endif
 
 /// @defgroup Thread Thread
+/// @ingroup Core
 namespace crown
 {
 /// Thread.

+ 5 - 0
src/core/types.h

@@ -7,8 +7,12 @@
 
 #include <stdint.h>
 
+/// @defgroup Core Core
+
 namespace crown
 {
+/// @addtogroup Core
+/// @{
 typedef int8_t   s8;
 typedef uint8_t  u8;
 typedef int16_t  s16;
@@ -19,6 +23,7 @@ typedef int64_t  s64;
 typedef uint64_t u64;
 typedef float    f32;
 typedef double   f64;
+/// @}
 
 } // namespace crown
 

+ 1 - 0
src/device/input_types.h

@@ -6,6 +6,7 @@
 #pragma once
 
 /// @defgroup Input Input
+/// @ingroup Device
 namespace crown
 {
 class InputManager;

+ 2 - 3
src/device/profiler.h

@@ -8,12 +8,11 @@
 #include "types.h"
 #include "math_types.h"
 
-/// @defgroup Profiler Profiler
 namespace crown
 {
 /// Enumerates profiler event types.
 ///
-/// @ingroup Profiler
+/// @ingroup Device
 struct ProfilerEventType
 {
 	enum Enum
@@ -66,7 +65,7 @@ struct DeallocateMemory
 
 /// Functions to access profiler.
 ///
-/// @ingroup Profiler
+/// @ingroup Device
 ///
 /// @note
 /// The profiler does not copy pointer data.

+ 0 - 1
src/resource/resource_manager.h

@@ -12,7 +12,6 @@
 #include "string_id.h"
 #include "types.h"
 
-/// @defgroup Resource Resource
 namespace crown
 {
 /// Keeps track and manages resources loaded by ResourceLoader.

+ 31 - 27
src/resource/resource_types.h

@@ -5,6 +5,36 @@
 
 #pragma once
 
+/// @defgroup Resource Resource
+namespace crown
+{
+class ResourceLoader;
+class ResourceManager;
+struct ResourcePackage;
+
+struct ActorResource;
+struct ControllerResource;
+struct FontResource;
+struct JointResource;
+struct LevelResource;
+struct LuaResource;
+struct MaterialResource;
+struct MeshResource;
+struct PackageResource;
+struct PhysicsConfigResource;
+struct PhysicsResource;
+struct ShaderResource;
+struct ShapeResource;
+struct SoundResource;
+struct SpriteAnimationResource;
+struct SpriteResource;
+struct TextureResource;
+struct UnitResource;
+
+} // namespace crown
+
+/// @addtogroup Resource
+/// @{
 #define RESOURCE_EXTENSION_CONFIG           "config"
 #define RESOURCE_EXTENSION_FONT             "font"
 #define RESOURCE_EXTENSION_LEVEL            "level"
@@ -52,30 +82,4 @@
 #define RESOURCE_VERSION_SPRITE           u32(1)
 #define RESOURCE_VERSION_TEXTURE          u32(1)
 #define RESOURCE_VERSION_UNIT             u32(1)
-
-namespace crown
-{
-class ResourceLoader;
-class ResourceManager;
-struct ResourcePackage;
-
-struct ActorResource;
-struct ControllerResource;
-struct FontResource;
-struct JointResource;
-struct LevelResource;
-struct LuaResource;
-struct MaterialResource;
-struct MeshResource;
-struct PackageResource;
-struct PhysicsConfigResource;
-struct PhysicsResource;
-struct ShaderResource;
-struct ShapeResource;
-struct SoundResource;
-struct SpriteAnimationResource;
-struct SpriteResource;
-struct TextureResource;
-struct UnitResource;
-
-} // namespace crown
+/// @}