Doc

#include <Ultralight/js/API.h>

Overview

A documentation string for a registration (shown in API::schema()).

The text becomes the entry's doc field in API::schema(). Pass at most one, to the same calls that take js::Param. The text is read during the call, so it doesn't need to outlive it.

api.Bind("save", &SaveGame, js::Doc("Saves the current session to disk."));

Public Member Functions
constexpr	Doc (const char *doc_text)
	Create a documentation annotation.

Public Attributes
const char *	text
	The documentation text.

Constructor & Destructor Documentation

Doc()

Doc ( const char * doc_text )

inlineexplicitconstexpr

Create a documentation annotation.

Parameters

doc_text

The documentation text.

Member Data Documentation

text

const char* text

The documentation text.

---

The documentation for this struct was generated from the following file:

• Ultralight/js/API.h