doc.h File Reference

Doc module. More...

Go to the source code of this file.

Classes
struct	EcsDocDescription
	Component that stores description. More...

Typedefs
typedef struct EcsDocDescription	EcsDocDescription
	Component that stores description.

Functions
FLECS_API const ecs_entity_t	ecs_id (EcsDocDescription)
	Component id for EcsDocDescription.
FLECS_API void	ecs_doc_set_name (ecs_world_t *world, ecs_entity_t entity, const char *name)
	Add human-readable name to entity.
FLECS_API void	ecs_doc_set_brief (ecs_world_t *world, ecs_entity_t entity, const char *description)
	Add brief description to entity.
FLECS_API void	ecs_doc_set_detail (ecs_world_t *world, ecs_entity_t entity, const char *description)
	Add detailed description to entity.
FLECS_API void	ecs_doc_set_link (ecs_world_t *world, ecs_entity_t entity, const char *link)
	Add link to external documentation to entity.
FLECS_API void	ecs_doc_set_color (ecs_world_t *world, ecs_entity_t entity, const char *color)
	Add color to entity.
FLECS_API const char *	ecs_doc_get_name (const ecs_world_t *world, ecs_entity_t entity)
	Get human readable name from entity.
FLECS_API const char *	ecs_doc_get_brief (const ecs_world_t *world, ecs_entity_t entity)
	Get brief description from entity.
FLECS_API const char *	ecs_doc_get_detail (const ecs_world_t *world, ecs_entity_t entity)
	Get detailed description from entity.
FLECS_API const char *	ecs_doc_get_link (const ecs_world_t *world, ecs_entity_t entity)
	Get link to external documentation from entity.
FLECS_API const char *	ecs_doc_get_color (const ecs_world_t *world, ecs_entity_t entity)
	Get color from entity.
FLECS_API void	FlecsDocImport (ecs_world_t *world)
	Doc module import function.

Variables
FLECS_API const ecs_entity_t	EcsDocBrief
	Tag for adding brief descriptions to entities.
FLECS_API const ecs_entity_t	EcsDocDetail
	Tag for adding detailed descriptions to entities.
FLECS_API const ecs_entity_t	EcsDocLink
	Tag for adding a link to entities.
FLECS_API const ecs_entity_t	EcsDocColor
	Tag for adding a color to entities.

Detailed Description

Doc module.

The doc module allows for documenting entities (and thus components, systems) by adding brief and/or detailed descriptions as components. Documentation added with the doc module can be retrieved at runtime, and can be used by tooling such as UIs or documentation frameworks.

Definition in file doc.h.