diff --git a/README.md b/README.md index 3305ee6c3..49ef95adb 100644 --- a/README.md +++ b/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. 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.
Take also a look at the [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 2dde62a93..099cfb4c1 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -24,15 +24,15 @@ install( add_custom_target( docs_aob 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 ) diff --git a/docs/extra.dox b/docs/dox/extra.dox similarity index 100% rename from docs/extra.dox rename to docs/dox/extra.dox diff --git a/docs/doxy.in b/docs/doxy.in index deb486b4d..26badb232 100644 --- a/docs/doxy.in +++ b/docs/doxy.in @@ -780,7 +780,9 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # 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 # 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, # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. -FILE_PATTERNS = *.cpp \ - *.c++ \ - *.h \ +FILE_PATTERNS = *.h \ *.hpp \ *.md \ *.dox diff --git a/docs/CONTRIBUTING.md b/docs/md/CONTRIBUTING.md similarity index 100% rename from docs/CONTRIBUTING.md rename to docs/md/CONTRIBUTING.md diff --git a/docs/core.md b/docs/md/core.md similarity index 100% rename from docs/core.md rename to docs/md/core.md diff --git a/docs/entity.md b/docs/md/entity.md similarity index 100% rename from docs/entity.md rename to docs/md/entity.md diff --git a/docs/lib.md b/docs/md/lib.md similarity index 100% rename from docs/lib.md rename to docs/md/lib.md diff --git a/docs/links.md b/docs/md/links.md similarity index 100% rename from docs/links.md rename to docs/md/links.md diff --git a/docs/locator.md b/docs/md/locator.md similarity index 100% rename from docs/locator.md rename to docs/md/locator.md diff --git a/docs/meta.md b/docs/md/meta.md similarity index 100% rename from docs/meta.md rename to docs/md/meta.md diff --git a/docs/process.md b/docs/md/process.md similarity index 100% rename from docs/process.md rename to docs/md/process.md diff --git a/docs/resource.md b/docs/md/resource.md similarity index 100% rename from docs/resource.md rename to docs/md/resource.md diff --git a/docs/signal.md b/docs/md/signal.md similarity index 100% rename from docs/signal.md rename to docs/md/signal.md diff --git a/src/entt/entity/fwd.hpp b/src/entt/entity/fwd.hpp index 26921ff12..e1a8ebe6d 100644 --- a/src/entt/entity/fwd.hpp +++ b/src/entt/entity/fwd.hpp @@ -7,40 +7,39 @@ namespace entt { - -/*! @brief Forward declaration of the registry class. */ +/*! @class basic_registry */ template class basic_registry; -/*! @brief Forward declaration of the view class. */ +/*! @class basic_view */ template class basic_view; -/*! @brief Forward declaration of the runtime view class. */ +/*! @class basic_runtime_view */ template class basic_runtime_view; -/*! @brief Forward declaration of the group class. */ +/*! @class basic_group */ template class basic_group; -/*! @brief Forward declaration of the actor class. */ +/*! @class basic_actor */ template struct basic_actor; -/*! @brief Forward declaration of the prototype class. */ +/*! @class basic_prototype */ template class basic_prototype; -/*! @brief Forward declaration of the snapshot class. */ +/*! @class basic_snapshot */ template class basic_snapshot; -/*! @brief Forward declaration of the snapshot loader class. */ +/*! @class basic_snapshot_loader */ template class basic_snapshot_loader; -/*! @brief Forward declaration of the continuous loader class. */ +/*! @class basic_continuous_loader */ template class basic_continuous_loader; diff --git a/src/entt/resource/fwd.hpp b/src/entt/resource/fwd.hpp index 968913f05..e85fe6b17 100644 --- a/src/entt/resource/fwd.hpp +++ b/src/entt/resource/fwd.hpp @@ -8,15 +8,15 @@ namespace entt { -/*! @brief Forward declaration of the resource cache class. */ +/*! @class resource_cache */ template class resource_cache; -/*! @brief Forward declaration of the resource handle class. */ +/*! @class resource_handle */ template class resource_handle; -/*! @brief Forward declaration of the resource loader class. */ +/*! @class resource_loader */ template class resource_loader; diff --git a/src/entt/signal/fwd.hpp b/src/entt/signal/fwd.hpp index 973bb67e0..0433bd36f 100644 --- a/src/entt/signal/fwd.hpp +++ b/src/entt/signal/fwd.hpp @@ -8,15 +8,15 @@ namespace entt { -/*! @brief Forward declaration of the delegate class. */ +/*! @class delegate */ template class delegate; -/*! @brief Forward declaration of the sink class. */ +/*! @class sink */ template class sink; -/*! @brief Forward declaration of the sigh class. */ +/*! @class sigh */ template struct sigh;