All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Welcome to the Nigntingale API documentation

Documenting Nightingale

Doxygen documentation is generated from all source files (*.cpp, *.dox, *.h, *.idl, *.js) within the directories ./app, ./components, ./dependencies/vendor, ./bindings, ./extensions, and ./documentation/docincludes

Creating Documentation

We generally use the Mozilla IDL commentary style guide.

See the Doxygen manual for general Doxygen reference.

Custom Doxygen Commands

\cid

Usage \cid {UUID}

This command generates the following output:

CID
{UUID}

\contractid

Usage \contractid @domain.tld/component/feature;version

This command generates the following output:

Contract ID
@domain.tld/component/feature;version