Skip to content

Commit 2cebc4f

Browse files
peter-bpeter-b
committed
[Bug 16827] dictionary: Fix some (ab|mis)use of enums annotations
Partially fix bug 16827 by modifying several dictionary entries in order to: * Remove redundant "one of the following"-type sentences/clauses * Make formatting more consistent * Remove "enum" annotations where the value isn't actuall an enumeration
1 parent a67597d commit 2cebc4f

53 files changed

Lines changed: 321 additions & 296 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/dictionary/command/answer-color.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Example:
2525
answer color with "AliceBlue"
2626

2727
Parameters:
28-
startingColor (enum): A color reference consisting of one of the following:
28+
startingColor: A <color reference> in one of the following forms:
2929
- a standard color name
3030
- three comma-separated integers between zero and 255, specifying the level of each of red, green, and blue
3131
- an HTML-style color consisting of a hash mark (#) followed by three hexadecimal numbers, one for each of red, green, and blue.
@@ -46,6 +46,6 @@ The color is returned in the form of three comma-separated integers between zero
4646
Changes:
4747
The option to specify a startingColor was introduced in version 1.1.1. In previous versions, the dialog box displayed white by default.
4848

49-
References: systemColorSelector (property), backgroundColor (property), colors (property), foregroundColor (property), it (keyword), answer (command), result (function), colorNames (function), dialog box (glossary), variable (glossary), command (glossary), return (glossary), function (control_st)
49+
References: systemColorSelector (property), backgroundColor (property), colors (property), foregroundColor (property), it (keyword), answer (command), result (function), colorNames (function), dialog box (glossary), variable (glossary), command (glossary), return (glossary), function (control_st), color reference (glossary)
5050

5151
Tags: ui

‎docs/dictionary/command/answer.lcdoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ Example:
2525
answer the currPrompt of me with "OK" or "Cancel" as sheet
2626

2727
Parameters:
28-
iconType (enum): Displayed on the left side of the dialog box. If you do not specify an icon, none is displayed. One of the following types:
29-
- "information"
30-
- "question"
31-
- "error"
32-
- "warning"
28+
iconType (enum): Displayed on the left side of the dialog box. If you do not specify an icon, none is displayed.
29+
- information : Non-critical notification
30+
- question : Request for information from the user
31+
- error : Notification of error or failure condition
32+
- warning : Notification of unexpected or abnormal condition
3333
prompt (string): The dialog box expands if necessary to fit the contents on desktops, display space on iOS and Android devices can be more restrictive and not provide enough space to expand sufficiently.
3434
button1:
3535
buttons: Up to seven buttons can be specified, separated by the word "or". The buttons and the dialog box expand if necessary to fit the button names; the total number of characters in the buttons is limited only by the maximum dialog box size and the font size. Display space on iOS and Android devices can be more restrictive and not provide enough space to expand sufficiently. The last button you specify is the default button. Pressing Return or Enter is equivalent to clicking the default button. If you do not specify any button names, the dialog box contains a single OK button.

‎docs/dictionary/command/ask.lcdoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ Example:
2828
ask "Please say hello:" with "DEFAULT" titled "Hello World"
2929

3030
Parameters:
31-
iconType (enum): The icon that is displayed on the left side of the dialog box. If you do not specify an icon, none is displayed. iOS and Android do not support iconType. The following types are supported:
32-
- "information"
33-
- "question"
34-
- "error"
35-
- "warning"
31+
iconType (enum): The icon that is displayed on the left side of the dialog box. If you do not specify an icon, none is displayed. iOS and Android do not support <iconType>.
32+
- information : Non-critical notification
33+
- question : Request for information from the user
34+
- error : Notification of error or failure condition
35+
- warning : Notification of unexpected or abnormal condition
3636
question (string): A string of formatted (or unformated) text.
3737
defaultResponse (string): A string, and is placed in the text box when the dialog box appears. If no defaultResponse is specified, the text box is empty when the dialog box appears.
3838
windowTitle: Appears in the title bar of the dialog box. If no windowTitle is given, the title bar is blank.

‎docs/dictionary/command/convert.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ convert the date && the time to seconds
2626

2727
Parameters:
2828
dateAndTime (string): A string or container with a date, a time, or a date and time separated by a space, tab, or return character.
29-
format (enum): One of the following (examples are February 17, 2000 at 10:13:21 PM, in the Eastern time zone, using US date and time formats): If you specify both a date and time format, they can be in either order and must be separated by a space. The resulting date and time are in the order you provided, separated by a space. If you specify seconds or dateItems, you can request only one format.
29+
format: One of the following (examples are February 17, 2000 at 10:13:21 PM, in the Eastern time zone, using US date and time formats): If you specify both a date and time format, they can be in either order and must be separated by a space. The resulting date and time are in the order you provided, separated by a space. If you specify seconds or dateItems, you can request only one format.
3030
- "short date": 2/17/00
3131
- "abbreviated date": Thu, Feb 17, 2000
3232
- "long date": Thursday, February 17, 2000

‎docs/dictionary/command/dispatch.lcdoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ message: Is an expression that evaluates to the name of a handler.
2323
target: A reference to any LiveCode object.
2424
argumentList: A comma separated list of expressions containing the arguments to send.
2525

26-
It (enum): Once finished, the variable ' <it> ' contains one of the following three values:
27-
-"handled" : the message was handled and not passed
28-
-"unhandled" : no matching handlers were found
29-
-"passed" : the message was handled but passed by all handlers
26+
It (enum): Set by <dispatch> to indicate how the message was processed.
27+
- handled : the message was handled and not passed
28+
- unhandled : no matching handlers were found
29+
- passed : the message was handled but passed by all handlers
3030

3131
Description:
3232
Use the <dispatch> command to send a mesage to an object, via the message path and find out whether it was handled or not.

‎docs/dictionary/command/export-snapshot.lcdoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ object:
3434
metadata (array): The <metadata> is an array of metadata. Currently the only key supported is "density" with a value in pixels per inch (ppi).
3535
filePath: Specifies the name and location of the file you want to export to. If you specify a name but not a location, the file is created in the <defaultFolder>.
3636
container: A reference to a container, usually an image or a URL.
37-
format (enum): One of the following: paint, JPEG, GIF, or PNG.
38-
- "paint": save the exported image in PBM format (paint) format
39-
- "JPEG": save the exported image in JPEG format
40-
- "GIF": save the exported image in GIF format
41-
- "PNG": save the exported image in PNG format
37+
format (enum): The desired file format to save.
38+
- paint : PBM
39+
- JPEG: Joint Photographic Experts Group
40+
- GIF: Graphics Interchange Format
41+
- PNG: Portable Network Graphics
4242
maskFile: Specifies the name and location of a file to export as an image mask. You can use a maskFile only when exporting in PBM format (paint).
4343
effect: Specifies whether graphic effects and a blendLevel should be applied to the object before rendering export.
4444
...: Denotes the usual possible suffixes for the export snapshot command.

‎docs/dictionary/command/export.lcdoc‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ Example:
2929
export image thisImage to file "Thumbnail" as PNG
3030

3131
Parameters:
32-
format: One of the following: paint, JPEG, GIF, BMP or PNG.
32+
format(enum): The desired file format to export.
33+
- paint : PBM, PGM, or PPM
34+
- JPEG : Joint Photographic Experts Group
35+
- GIF : Graphics Interchange Format
36+
- BMP : device independent bitmap
37+
- PNG : Portable Network Graphics
3338
metadata:
3439
filePath: The filePath specifies the name and location of the file you want to export to. If you specify a name but not a location, the file is created in the defaultFolder.
3540
container: A reference to a container, usually another image or a URL.

‎docs/dictionary/command/find.lcdoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Example:
2121
find string "beat must go on" in field "Quotes"
2222

2323
Parameters:
24-
form (enum): One of the following words:If no form is specified, the find normal form is used.
25-
- normal
26-
- characters or character (or chars or char)
27-
- words or word
28-
- string
29-
- whole
24+
form (enum): If no <form> is specified, the normal form is used.
25+
- normal : Find each word in textToFind, at start of the field's words
26+
- characters, character, chars, char : Find each word in textToFind, anywhere in the field's words
27+
- words, word : Find each word in textToFind, as complete words
28+
- whole : Find the whole of textToFind, as a sequence of complete words
29+
- string : Find the whole of textToFind, anywhere
3030
textToFind (string):
3131
field: Any expression that evaluates to a field reference. If the field is not specified, the find command searches all the fields in the current stack (except fields whose dontSearch property is set to true).
3232

‎docs/dictionary/command/go.lcdoc‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ go invisible stack "Preferences"
3838
Parameters:
3939
card: Any card reference. Cards can be described by their name, number, or ID properties.
4040
stack: Any stack reference, or any file path or http URL reference that resolves to a stack file. If you specify a file path or http URL, the command opens the main stack of the specified stack file.
41-
mode (enum): one of the following:
42-
- "editable window"
43-
- "palette"
44-
- "modal dialog box"
45-
- "modeless dialog box"
46-
- "sheet dialog box": appears in defaultStack
47-
- "drawer": appears in defaultStack, centered at left side if there's room
41+
mode (enum):
42+
- editable window :
43+
- palette :
44+
- modal dialog box :
45+
- modeless dialog box :
46+
- sheet dialog box : appears in <defaultStack>
47+
- drawer : appears in <defaultStack>, centered at left side if there's room
4848
window: The name or windowID property of any open stack. If a window is specified, the stack opens in that window, replacing the stack that was previously displayed in that window.
4949
number: The number of cards to move within the recent cards list.
5050

@@ -93,6 +93,6 @@ if there is a stack myPath then go card 2 of stack myPath
9393

9494
The go... as sheet form was introduced in version 2.0. Previous versions did not support sheet dialogs.
9595

96-
References: lockRecent property (property), lockScreen (property), lockScreen property (property), HCImportStat (property), visible property (property), previous (keyword), recent (keyword), as (keyword), card (keyword), unlock recent (command), show command (command), show cards (command), drawer (command), modeless (command), push (command), stack (object)
96+
References: lockRecent property (property), lockScreen (property), lockScreen property (property), HCImportStat (property), visible property (property), previous (keyword), recent (keyword), as (keyword), card (keyword), unlock recent (command), show command (command), show cards (command), drawer (command), modeless (command), push (command), stack (object), defaultStack (property)
9797

9898
Tags: navigation

‎docs/dictionary/command/iphoneSetKeyboardReturnKey.lcdoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ Example:
1919
iphoneSetKeyboardReturnKey "numeric"
2020

2121
Parameters:
22-
returnKey (enum): Specifies what the return key function is. This is one of the following:
23-
- "default": the normal return key
24-
- "go": the 'Go' return key
25-
- "google": the 'Google' return key
26-
- "join": the 'Join' return key
27-
- "next": the 'Next' return key
28-
- "route": the 'Route' return key
29-
- "search": the 'Search' return key
30-
- "send": the 'Send' return key
31-
- "yahoo": the 'Yahoo' return key
32-
- "done": the 'Done' return key
33-
- "emergency call": the 'emergency call' return key
22+
returnKey (enum): Specifies what the return key function is.
23+
- default: the normal return key
24+
- go: the 'Go' return key
25+
- google: the 'Google' return key
26+
- join: the 'Join' return key
27+
- next: the 'Next' return key
28+
- route: the 'Route' return key
29+
- search: the 'Search' return key
30+
- send: the 'Send' return key
31+
- yahoo: the 'Yahoo' return key
32+
- done: the 'Done' return key
33+
- emergency call: the 'emergency call' return key
3434

3535
Description:
3636
Use the iphoneSetKeyboardReturnKey command to configure the type of return key displayed on the keyboard.

0 commit comments

Comments
 (0)