![]() |
Flecs v4.0
A fast entity component system (ECS) for C & C++
|
Utilities for documenting entities, components and systems. More...
Typedefs | |
using | flecs::doc::Description = EcsDocDescription |
flecs.doc.Description component |
Functions | |
const char * | flecs::entity_view::doc_name () const |
Get human readable name. | |
const char * | flecs::entity_view::doc_brief () const |
Get brief description. | |
const char * | flecs::entity_view::doc_detail () const |
Get detailed description. | |
const char * | flecs::entity_view::doc_link () const |
Get link to external documentation. | |
const char * | flecs::entity_view::doc_color () const |
Get color. | |
const char * | flecs::entity_view::doc_uuid () const |
Get UUID. | |
const char * | flecs::doc::get_uuid (const flecs::entity_view &e) |
Get UUID for an entity. | |
const char * | flecs::doc::get_name (const flecs::entity_view &e) |
Get human readable name for an entity. | |
const char * | flecs::doc::get_brief (const flecs::entity_view &e) |
Get brief description for an entity. | |
const char * | flecs::doc::get_detail (const flecs::entity_view &e) |
Get detailed description for an entity. | |
const char * | flecs::doc::get_link (const flecs::entity_view &e) |
Get link to external documentation for an entity. | |
const char * | flecs::doc::get_color (const flecs::entity_view &e) |
Get color for an entity. | |
void | flecs::doc::set_uuid (flecs::entity &e, const char *uuid) |
Set UUID for an entity. | |
void | flecs::doc::set_name (flecs::entity &e, const char *name) |
Set human readable name for an entity. | |
void | flecs::doc::set_brief (flecs::entity &e, const char *description) |
Set brief description for an entity. | |
void | flecs::doc::set_detail (flecs::entity &e, const char *description) |
Set detailed description for an entity. | |
void | flecs::doc::set_link (flecs::entity &e, const char *link) |
Set link to external documentation for an entity. | |
void | flecs::doc::set_color (flecs::entity &e, const char *color) |
Set color for an entity. | |
const Self & | flecs::entity_builder< Self >::set_doc_name (const char *name) const |
Set human readable name. | |
const Self & | flecs::entity_builder< Self >::set_doc_brief (const char *brief) const |
Set brief description. | |
const Self & | flecs::entity_builder< Self >::set_doc_detail (const char *detail) const |
Set detailed description. | |
const Self & | flecs::entity_builder< Self >::set_doc_link (const char *link) const |
Set link to external documentation. | |
const Self & | flecs::entity_builder< Self >::set_doc_color (const char *color) const |
Set doc color. | |
const Self & | flecs::entity_builder< Self >::set_doc_uuid (const char *uuid) const |
Set doc UUID. |
Utilities for documenting entities, components and systems.
flecs.doc.Description component
|
inline |
Get brief description.
Definition at line 29 of file entity_view.hpp.
|
inline |
Get color.
Definition at line 68 of file entity_view.hpp.
|
inline |
Get detailed description.
Definition at line 42 of file entity_view.hpp.
|
inline |
Get link to external documentation.
Definition at line 55 of file entity_view.hpp.
|
inline |
Get human readable name.
Definition at line 16 of file entity_view.hpp.
|
inline |
Get UUID.
Definition at line 81 of file entity_view.hpp.
|
inline |
Get brief description for an entity.
|
inline |
Get color for an entity.
|
inline |
Get detailed description for an entity.
|
inline |
Get link to external documentation for an entity.
|
inline |
Get human readable name for an entity.
|
inline |
Get UUID for an entity.
|
inline |
Set brief description for an entity.
|
inline |
Set color for an entity.
|
inline |
Set detailed description for an entity.
|
inline |
Set brief description.
This adds (flecs.doc.Description, flecs.doc.Brief) to the entity.
Definition at line 32 of file builder.hpp.
|
inline |
Set doc color.
This adds (flecs.doc.Description, flecs.doc.Color) to the entity.
Definition at line 77 of file builder.hpp.
|
inline |
Set detailed description.
This adds (flecs.doc.Description, flecs.doc.Detail) to the entity.
Definition at line 47 of file builder.hpp.
|
inline |
Set link to external documentation.
This adds (flecs.doc.Description, flecs.doc.Link) to the entity.
Definition at line 62 of file builder.hpp.
|
inline |
Set human readable name.
This adds (flecs.doc.Description, flecs.Name) to the entity.
Definition at line 17 of file builder.hpp.
|
inline |
Set doc UUID.
This adds (flecs.doc.Description, flecs.doc.Uuid) to the entity.
Definition at line 92 of file builder.hpp.
|
inline |
Set link to external documentation for an entity.
|
inline |
Set human readable name for an entity.
|
inline |
Set UUID for an entity.