[Darwin] Improve documentation for enum array properties

This commit is contained in:
Mikhail Pozdnyakov
2019-03-28 12:06:43 +02:00
parent 1eaae50ffe
commit 2cfdd1a2f7
2 changed files with 21 additions and 1 deletions

View File

@@ -352,6 +352,9 @@ global.propertyDoc = function (propertyName, property, layerType, kind) {
if (property.type === 'enum') {
doc += '* Any of the following constant string values:\n';
doc += Object.keys(property.values).map(value => ' * `' + value + '`: ' + property.values[value].doc).join('\n') + '\n';
} else if (property.type === 'array' && property.value === 'enum') {
doc += '* Constant array, whose each element is any of the following constant string values:\n';
doc += Object.keys(property.values).map(value => ' * `' + value + '`: ' + property.values[value].doc).join('\n') + '\n';
}
doc += '* Predefined functions, including mathematical and string operators\n' +
'* Conditional expressions\n' +
@@ -426,6 +429,8 @@ global.describeType = function (property) {
return '`CGVector`';
case 'position':
return '`MGLSphericalPosition`';
case 'anchor':
return '`MGLTextAnchor` array';
default:
return 'array';
}

View File

@@ -1589,7 +1589,22 @@ MGL_EXPORT
You can set this property to an expression containing any of the following:
* Constant array values
* Constant `MGLTextAnchor` array values
* Constant array, whose each element is any of the following constant string
values:
* `center`: The center of the text is placed closest to the anchor.
* `left`: The left side of the text is placed closest to the anchor.
* `right`: The right side of the text is placed closest to the anchor.
* `top`: The top of the text is placed closest to the anchor.
* `bottom`: The bottom of the text is placed closest to the anchor.
* `top-left`: The top left corner of the text is placed closest to the
anchor.
* `top-right`: The top right corner of the text is placed closest to the
anchor.
* `bottom-left`: The bottom left corner of the text is placed closest to the
anchor.
* `bottom-right`: The bottom right corner of the text is placed closest to
the anchor.
* Predefined functions, including mathematical and string operators
* Conditional expressions
* Variable assignments and references to assigned variables