Michele Caini 7 лет назад
Родитель
Сommit
112d13c127

+ 1 - 1
README.md

@@ -348,7 +348,7 @@ I can't promise that each and every contribution will be accepted, but I can
 assure that I'll do my best to take them all seriously.
 assure that I'll do my best to take them all seriously.
 
 
 If you decide to participate, please see the guidelines for
 If you decide to participate, please see the guidelines for
-[contributing](docs/CONTRIBUTING.md) before to create issues or pull
+[contributing](docs/md/CONTRIBUTING.md) before to create issues or pull
 requests.<br/>
 requests.<br/>
 Take also a look at the
 Take also a look at the
 [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to
 [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to

+ 11 - 11
docs/CMakeLists.txt

@@ -24,15 +24,15 @@ install(
 add_custom_target(
 add_custom_target(
     docs_aob
     docs_aob
     SOURCES
     SOURCES
-        CONTRIBUTING.md
-        core.md
-        entity.md
-        lib.md
-        links.md
-        locator.md
-        meta.md
-        process.md
-        resource.md
-        signal.md
-        extra.dox
+        md/CONTRIBUTING.md
+        md/core.md
+        md/entity.md
+        md/lib.md
+        md/links.md
+        md/locator.md
+        md/meta.md
+        md/process.md
+        md/resource.md
+        md/signal.md
+        dox/extra.dox
 )
 )

+ 0 - 0
docs/extra.dox → docs/dox/extra.dox


+ 4 - 4
docs/doxy.in

@@ -780,7 +780,9 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 # Note: If this tag is empty the current directory is searched.
 
 
-INPUT                  = @DOXY_SOURCE_DIRECTORY@ @DOXY_DOCS_DIRECTORY@ @PROJECT_SOURCE_DIR@/README.md
+INPUT                  = @DOXY_SOURCE_DIRECTORY@ \
+			 @DOXY_DOCS_DIRECTORY@ \
+			 @PROJECT_SOURCE_DIR@/README.md
 
 
 # This tag can be used to specify the character encoding of the source files
 # 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
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -805,9 +807,7 @@ INPUT_ENCODING         = UTF-8
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
 
 
-FILE_PATTERNS          = *.cpp \
-                         *.c++ \
-                         *.h \
+FILE_PATTERNS          = *.h \
                          *.hpp \
                          *.hpp \
                          *.md \
                          *.md \
                          *.dox
                          *.dox

+ 0 - 0
docs/CONTRIBUTING.md → docs/md/CONTRIBUTING.md


+ 0 - 0
docs/core.md → docs/md/core.md


+ 0 - 0
docs/entity.md → docs/md/entity.md


+ 0 - 0
docs/lib.md → docs/md/lib.md


+ 0 - 0
docs/links.md → docs/md/links.md


+ 0 - 0
docs/locator.md → docs/md/locator.md


+ 0 - 0
docs/meta.md → docs/md/meta.md


+ 0 - 0
docs/process.md → docs/md/process.md


+ 0 - 0
docs/resource.md → docs/md/resource.md


+ 0 - 0
docs/signal.md → docs/md/signal.md


+ 9 - 10
src/entt/entity/fwd.hpp

@@ -7,40 +7,39 @@
 
 
 namespace entt {
 namespace entt {
 
 
-
-/*! @brief Forward declaration of the registry class. */
+/*! @class basic_registry */
 template <typename>
 template <typename>
 class basic_registry;
 class basic_registry;
 
 
-/*! @brief Forward declaration of the view class. */
+/*! @class basic_view */
 template<typename, typename...>
 template<typename, typename...>
 class basic_view;
 class basic_view;
 
 
-/*! @brief Forward declaration of the runtime view class. */
+/*! @class basic_runtime_view */
 template<typename>
 template<typename>
 class basic_runtime_view;
 class basic_runtime_view;
 
 
-/*! @brief Forward declaration of the group class. */
+/*! @class basic_group */
 template<typename...>
 template<typename...>
 class basic_group;
 class basic_group;
 
 
-/*! @brief Forward declaration of the actor class. */
+/*! @class basic_actor */
 template <typename>
 template <typename>
 struct basic_actor;
 struct basic_actor;
 
 
-/*! @brief Forward declaration of the prototype class. */
+/*! @class basic_prototype */
 template<typename>
 template<typename>
 class basic_prototype;
 class basic_prototype;
 
 
-/*! @brief Forward declaration of the snapshot class. */
+/*! @class basic_snapshot */
 template<typename>
 template<typename>
 class basic_snapshot;
 class basic_snapshot;
 
 
-/*! @brief Forward declaration of the snapshot loader class. */
+/*! @class basic_snapshot_loader */
 template<typename>
 template<typename>
 class basic_snapshot_loader;
 class basic_snapshot_loader;
 
 
-/*! @brief Forward declaration of the continuous loader class. */
+/*! @class basic_continuous_loader */
 template<typename>
 template<typename>
 class basic_continuous_loader;
 class basic_continuous_loader;
 
 

+ 3 - 3
src/entt/resource/fwd.hpp

@@ -8,15 +8,15 @@
 namespace entt {
 namespace entt {
 
 
 
 
-/*! @brief Forward declaration of the resource cache class. */
+/*! @class resource_cache */
 template<typename>
 template<typename>
 class resource_cache;
 class resource_cache;
 
 
-/*! @brief Forward declaration of the resource handle class. */
+/*! @class resource_handle */
 template<typename>
 template<typename>
 class resource_handle;
 class resource_handle;
 
 
-/*! @brief Forward declaration of the resource loader class. */
+/*! @class resource_loader */
 template<typename, typename>
 template<typename, typename>
 class resource_loader;
 class resource_loader;
 
 

+ 3 - 3
src/entt/signal/fwd.hpp

@@ -8,15 +8,15 @@
 namespace entt {
 namespace entt {
 
 
 
 
-/*! @brief Forward declaration of the delegate class. */
+/*! @class delegate */
 template<typename>
 template<typename>
 class delegate;
 class delegate;
 
 
-/*! @brief Forward declaration of the sink class. */
+/*! @class sink */
 template<typename>
 template<typename>
 class sink;
 class sink;
 
 
-/*! @brief Forward declaration of the sigh class. */
+/*! @class sigh */
 template<typename, typename>
 template<typename, typename>
 struct sigh;
 struct sigh;