Doc that represents function definition. More...

#include <doc.h>

Inheritance diagram for tvm::script::printer::FunctionDocNode:

Collaboration diagram for tvm::script::printer::FunctionDocNode:

Public Member Functions
	TVM_DECLARE_FINAL_OBJECT_INFO (FunctionDocNode, StmtDocNode)

Public Member Functions inherited from tvm::script::printer::StmtDocNode
	TVM_DECLARE_BASE_OBJECT_INFO (StmtDocNode, DocNode)

Public Member Functions inherited from tvm::script::printer::DocNode
	TVM_DECLARE_BASE_OBJECT_INFO (DocNode, Object)

virtual	~DocNode ()=default

Static Public Member Functions
static void	RegisterReflection ()

Static Public Member Functions inherited from tvm::script::printer::StmtDocNode
static void	RegisterReflection ()

Static Public Member Functions inherited from tvm::script::printer::DocNode
static void	RegisterReflection ()

Public Attributes
IdDoc	name {nullptr}
	The name of function. More...

Array< AssignDoc >	args
	The arguments of function. More...

Array< ExprDoc >	decorators
	Decorators of function. More...

Optional< ExprDoc >	return_type {std::nullopt}
	The return type of function. More...

Array< StmtDoc >	body
	The body of function. More...

Public Attributes inherited from tvm::script::printer::StmtDocNode
Optional< String >	comment {std::nullopt}
	The comment of this doc. More...

Public Attributes inherited from tvm::script::printer::DocNode
Array< ffi::reflection::AccessPath >	source_paths
	The list of object paths of the source IR node. More...

Static Public Attributes
static constexpr const char *	_type_key = "script.printer.FunctionDoc"

Static Public Attributes inherited from tvm::script::printer::StmtDocNode
static constexpr const char *	_type_key = "script.printer.StmtDoc"

Static Public Attributes inherited from tvm::script::printer::DocNode
static constexpr const char *	_type_key = "script.printer.Doc"

static constexpr bool	_type_mutable = true

Detailed Description

Doc that represents function definition.

See also: FunctionDoc

Member Function Documentation

◆ RegisterReflection()

static void tvm::script::printer::FunctionDocNode::RegisterReflection ( )

inlinestatic

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::script::printer::FunctionDocNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	FunctionDocNode	,
		StmtDocNode
	)

Member Data Documentation

◆ _type_key

constexpr const char* tvm::script::printer::FunctionDocNode::_type_key = "script.printer.FunctionDoc"

staticconstexpr

◆ args

Array<AssignDoc> tvm::script::printer::FunctionDocNode::args

The arguments of function.

The lhs means argument name, annotation means argument type, and rhs means default value.

◆ body

Array<StmtDoc> tvm::script::printer::FunctionDocNode::body

The body of function.

◆ decorators

Array<ExprDoc> tvm::script::printer::FunctionDocNode::decorators

Decorators of function.

◆ name

IdDoc tvm::script::printer::FunctionDocNode::name {nullptr}

The name of function.

◆ return_type

Optional<ExprDoc> tvm::script::printer::FunctionDocNode::return_type {std::nullopt}

The return type of function.

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

include/tvm/script/printer/doc.h

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes