@@ -5,7 +5,10 @@ type: object
5
5
6
6
properties :
7
7
shared :
8
- description : A shared specification of a function.
8
+ description : |
9
+ A shared specification of a function.
10
+ You must always create a server and a client property, and merge this into both
11
+ using a reference.
9
12
$ref : ' #/$defs/common_properties'
10
13
server :
11
14
description : A server-side specification of a function.
@@ -26,6 +29,13 @@ $defs:
26
29
pair :
27
30
type : string
28
31
description : Associates this function with another getter or setter function.
32
+ oop :
33
+ $ref : ' #/$defs/oop'
34
+ is_disabled :
35
+ type : string
36
+ description : Describe why the function was disabled, and if there is an alternative approach.
37
+ meta :
38
+ $ref : ' #/$defs/meta'
29
39
description :
30
40
type : string
31
41
description : Describes the functionality provided by the function.
@@ -58,18 +68,63 @@ $defs:
58
68
$ref : ' #/$defs/examples'
59
69
see_also :
60
70
type : array
61
- description : A list of other items and categories for further reading.
71
+ description : |
72
+ A list of other items and categories for further reading.
73
+ Every function will implicitly display it's own category in *See Also*, unless you
74
+ introduce this property, then you have to be explicit about it.
62
75
items :
63
76
type : string
64
77
pattern : " ^(item|category|tag):"
65
78
uniqueItems : true
66
79
80
+ oop :
81
+ type : object
82
+ description : Object-Oriented Programming (OOP) information block for the function.
83
+ required :
84
+ - entity
85
+ properties :
86
+ note :
87
+ type : string
88
+ description : A piece of information to show alongside OOP syntax.
89
+ entity :
90
+ type : string
91
+ description : Name of the element or userdata.
92
+ oneOf :
93
+ - required :
94
+ - method
95
+ properties :
96
+ method :
97
+ type : string
98
+ description : Name of the method.
99
+ static :
100
+ type : boolean
101
+ default : false
102
+ description : If set to true, this method will be marked as static.
103
+ variable :
104
+ type : string
105
+ description : Name of the variable without a leading dot.
106
+ - required :
107
+ - constructor
108
+ properties :
109
+ constructor :
110
+ type : string
111
+ description : Name of the constructor.
112
+
113
+ meta :
114
+ type : array
115
+ description : A list of meta properties about the function and it's documentation.
116
+ items :
117
+ type : object
118
+ properties :
119
+ needs_checking :
120
+ type : string
121
+ description : Describe why the function needs checking by another person. What's problematic?
122
+
67
123
preview :
68
124
type : array
69
125
description : A list of picture assets demonstrating the function.
70
126
items :
71
127
type : object
72
- description : A single function preview.
73
128
required :
74
129
- path
75
130
properties :
@@ -85,7 +140,6 @@ $defs:
85
140
description : A list of required and optional parameters for the function.
86
141
items :
87
142
type : object
88
- description : A single function parameter.
89
143
required :
90
144
- name
91
145
- type
@@ -123,7 +177,6 @@ $defs:
123
177
description : A list of named values returned by the function.
124
178
items :
125
179
type : object
126
- description : A single function return value.
127
180
required :
128
181
- type
129
182
- name
@@ -156,7 +209,6 @@ $defs:
156
209
description : A list of related issues for this function.
157
210
items :
158
211
type : object
159
- description : A single function-related issue.
160
212
required :
161
213
- id
162
214
- description
@@ -173,7 +225,6 @@ $defs:
173
225
description : A list of source code examples demonstrating the function.
174
226
items :
175
227
type : object
176
- description : A single source code example.
177
228
required :
178
229
- path
179
230
properties :
0 commit comments