Doc

Utilities for documenting entities, components and systems. More...

Typedefs
using	flecs::doc::Description = EcsDocDescription
	flecs.doc.Description component More...

Functions
Self &	flecs::entity_builder< Self >::set_doc_name (const char *name)
	Set doc name. More...
Self &	flecs::entity_builder< Self >::set_doc_brief (const char *brief)
	Set doc brief. More...
Self &	flecs::entity_builder< Self >::set_doc_detail (const char *detail)
	Set doc detailed description. More...
Self &	flecs::entity_builder< Self >::set_doc_link (const char *link)
	Set doc link. More...
Self &	flecs::entity_builder< Self >::set_doc_color (const char *link)
	Set doc color. More...

Detailed Description

Utilities for documenting entities, components and systems.

Typedef Documentation

Description

using flecs::doc::Description = typedef EcsDocDescription

flecs.doc.Description component

Definition at line 20 of file decl.hpp.

Function Documentation

set_doc_brief()

template<typename Self >

Self & set_doc_brief

(

const char *

brief

)

Set doc brief.

This adds (flecs.doc.Description, flecs.doc.Brief) to the entity.

Definition at line 23 of file entity_builder.inl.

set_doc_color()

template<typename Self >

Self & set_doc_color

(

const char *

link

)

Set doc color.

This adds (flecs.doc.Description, flecs.doc.Color) to the entity.

Definition at line 56 of file entity_builder.inl.

set_doc_detail()

template<typename Self >

Self & set_doc_detail

(

const char *

detail

)

Set doc detailed description.

This adds (flecs.doc.Description, flecs.doc.Detail) to the entity.

Definition at line 34 of file entity_builder.inl.

set_doc_link()

template<typename Self >

Self & set_doc_link

(

const char *

link

)

Set doc link.

This adds (flecs.doc.Description, flecs.doc.Link) to the entity.

Definition at line 45 of file entity_builder.inl.

set_doc_name()

template<typename Self >

Self & set_doc_name

(

const char *

name

)

Set doc name.

This adds (flecs.doc.Description, flecs.Name) to the entity.

Definition at line 12 of file entity_builder.inl.