Share

Annotation and parsing

Annotation is done in C++ header file using the AMINO_ANNOTATE() macro. Only functions and types that have been annotated are instantiated in a Bifrost graph.

For example:

void concatenate_strings(const Amino::String& first, const Amino::String& second, Amino::String& concatenated)
AMINO_ANNOTATE("Amino::Node");

This describes the function as an Amino::Node object. It will be instantiated in the Bifrost as a node named concatenate_string.

Any construct in your header file that is left without an annotation will be ignored by cpp2json.

You can have only one call to AMINO_ANNOTATE per construct, but you can have more than one annotation within the call to AMINO_ANNOTATE.

Was this information helpful?