Define TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC

Define TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC#

Define Documentation#

TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC(ExportName, DocString)#

Export documentation string for a typed function.

This macro exports a documentation string associated with a function export name. The docstring can be used by stub generators and documentation tools. This macro only exports the docstring; it does not export the function itself.

int Add(int a, int b) {
  return a + b;
}

TVM_FFI_DLL_EXPORT_TYPED_FUNC(add, Add);
TVM_FFI_DLL_EXPORT_TYPED_FUNC_DOC(
    add,
    R"(Add two integers and return the sum.

Parameters
----------
a : int
    First integer
b : int
    Second integer

Returns
-------
result : int
    Sum of a and b)");

See also

ffi::TypedFunction, TVM_FFI_DLL_EXPORT_TYPED_FUNC

Note

The exported symbol name is __tvm_ffi__doc_<ExportName> (docstring getter function). This symbol is only exported when TVM_FFI_DLL_EXPORT_INCLUDE_METADATA is defined.

Parameters:

  • ExportName – The symbol name that the docstring is associated with.

  • DocString – The documentation string (C string literal).

Contents