updated doc

This commit is contained in:
Michele Caini
2019-03-28 14:53:54 +01:00
parent 16afc9d0f8
commit 112d13c127
17 changed files with 31 additions and 32 deletions

View File

@@ -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.<br/>
Take also a look at the
[contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to

View File

@@ -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
)

View File

@@ -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

View File

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

View File

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

View File

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