summaryrefslogtreecommitdiff
path: root/docs/data/core/share.json
blob: 4d1df1fc97413e30a1df22c2e933ad5936c6c67a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
	"format": 1,
	"id": "saw-share",
	"kind": "function",
	"name": "share",
	"namespace": "saw",
	"module": "core",
	"header": "modules/core/c++/common.hpp",
	"type": [{"name": "our", "id": "saw-our"}, "< T >"],
	"brief_description": "Constructs an object on the heap under shared ownership.",
	"detailed_description": [
		[
			"The counterpart of",
			{"name": "heap", "id": "saw-heap"},
			"for the cases where ownership is genuinely shared."
		]
	],
	"templates": [
		{"name": "T", "kind": "type"},
		{"name": "Args", "kind": "type", "pack": true}
	],
	"parameters": [
		{"name": "args", "type": ["Args &&..."], "brief_description": "Forwarded to the constructor of T."}
	]
}