[#MRDOCS_KIND_ENTRY]
= MRDOCS_KIND_ENTRY
:mrdocs:

Emit the describe entry for one derived kind.

== Synopsis

Declared in `<mrdocs/Support/Reflection/Describe.hpp>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
#define MRDOCS_KIND_ENTRY(C, D)

----

== Description

Use it between `MRDOCS_DESCRIBE_KINDS_BEGIN` and `MRDOCS_DESCRIBE_KINDS_END`, one per derived class. Usually the X‐macro `INFO` points at it, so an `.inc` file with one `INFO(Name)` per kind supplies the entries:

[,cpp]
----
#define INFO(Name) MRDOCS_KIND_ENTRY(Shape, Name##Shape)
MRDOCS_DESCRIBE_KINDS_BEGIN(Shape)
#include "ShapeNodes.inc"
MRDOCS_DESCRIBE_KINDS_END(Shape)
----
You can also write the entries by hand:

[,cpp]
----
struct Node { int Kind; };
struct Leaf : Node {};
struct Branch : Node {};

MRDOCS_DESCRIBE_KINDS_BEGIN(Node)
    MRDOCS_KIND_ENTRY(Node, Leaf)
    MRDOCS_KIND_ENTRY(Node, Branch)
MRDOCS_DESCRIBE_KINDS_END(Node)
----
Each entry is a leading comma plus a descriptor object, which becomes one more argument of the call that `MRDOCS_DESCRIBE_KINDS_BEGIN` opens:

[,cpp]
----
// MRDOCS_KIND_ENTRY(Node, Leaf) expands to exactly:
, ::mrdocs::describe::detail::kind_descriptor<Node, Leaf>{}
----
Because of that leading comma it only makes sense in that spot&period; Don&apos;t put a `&semi;` after it, and don&apos;t use it with `MRDOCS&lowbar;DESCRIBE&lowbar;KINDS`, which writes its own entries&period; `D` may still be a forward declaration here&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *C*
| The polymorphic base class, the same one passed to `MRDOCS&lowbar;DESCRIBE&lowbar;KINDS&lowbar;BEGIN`&period;
| *D*
| The derived class&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#