Skip to content

Commit

Permalink
Docs: formatting fixes
Browse files Browse the repository at this point in the history
Missing spaces before parentheses. Badly formatted bold.
  • Loading branch information
joshtynjala committed May 7, 2024
1 parent 77088f4 commit 7ae1be7
Show file tree
Hide file tree
Showing 15 changed files with 57 additions and 59 deletions.
2 changes: 1 addition & 1 deletion src/openfl/display/DisplayObject.hx
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ import js.html.CSSStyleDeclaration;
by all display objects with a listener registered
for this event.
**Note: **This event is not dispatched if the
**Note:** This event is not dispatched if the
display is not rendering. This is the case when the
content is either minimized or obscured.
Expand Down
4 changes: 2 additions & 2 deletions src/openfl/display/Graphics.hx
Original file line number Diff line number Diff line change
Expand Up @@ -1330,10 +1330,10 @@ import js.html.CanvasRenderingContext2D;
drawing a path to specify different styles for different line segments
within the path.
**Note: **Calls to the `clear()` method set the line
**Note:** Calls to the `clear()` method set the line
style back to `undefined`.
**Note: **Flash Lite 4 supports only the first three parameters
**Note:** Flash Lite 4 supports only the first three parameters
(`thickness`, `color`, and `alpha`).
@param thickness An integer that indicates the thickness of the line in
Expand Down
4 changes: 2 additions & 2 deletions src/openfl/display/InteractiveObject.hx
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ import openfl.geom.Rectangle;
vary by device and operating system. This
event type is generated after such a mapping
occurs but before the processing of an input
method editor(IME). IMEs are used to enter
method editor (IME). IMEs are used to enter
characters, such as Chinese ideographs, that
the standard QWERTY keyboard is ill-equipped
to produce. This event occurs before the
Expand Down Expand Up @@ -435,7 +435,7 @@ import openfl.geom.Rectangle;
vary by device and operating system. This
event type is generated after such a mapping
occurs but before the processing of an input
method editor(IME). IMEs are used to enter
method editor (IME). IMEs are used to enter
characters, such as Chinese ideographs, that
the standard QWERTY keyboard is ill-equipped
to produce. This event occurs after a
Expand Down
2 changes: 1 addition & 1 deletion src/openfl/display/Loader.hx
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ class Loader extends DisplayObjectContainer
* Movie clips are stopped.
@param gc Provides a hint to the garbage collector to run on the child SWF
objects(`true`) or not(`false`). If you
objects (`true`) or not (`false`). If you
are unloading many objects asynchronously, setting the
`gc` paramter to `false` might improve
application performance. However, if the parameter is set to
Expand Down
4 changes: 2 additions & 2 deletions src/openfl/display/Sprite.hx
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,9 @@ class Sprite extends DisplayObjectContainer
plane defined by the three-dimensional parent object.
@param lockCenter Specifies whether the draggable sprite is locked to the
center of the pointer position(`true`), or
center of the pointer position (`true`), or
locked to the point where the user first clicked the
sprite(`false`).
sprite (`false`).
@param bounds Value relative to the coordinates of the Sprite's parent
that specify a constraint rectangle for the Sprite.
**/
Expand Down
6 changes: 3 additions & 3 deletions src/openfl/events/Event.hx
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ class Event
`stopPropagation()` method doesn't take effect until all the
event listeners in the current node finish processing.
**Note: ** This method does not cancel the behavior associated with
**Note:** This method does not cancel the behavior associated with
this event; see `preventDefault()` for that functionality.
**/
Expand All @@ -888,13 +888,13 @@ class Event
/**
Prevents processing of any event listeners in nodes subsequent to the
current node in the event flow. This method does not affect any event
listeners in the current node(`currentTarget`). In contrast,
listeners in the current node (`currentTarget`). In contrast,
the `stopImmediatePropagation()` method prevents processing of
event listeners in both the current node and subsequent nodes. Additional
calls to this method have no effect. This method can be called in any
phase of the event flow.
**Note: ** This method does not cancel the behavior associated with
**Note:** This method does not cancel the behavior associated with
this event; see `preventDefault()` for that functionality.
**/
Expand Down
12 changes: 6 additions & 6 deletions src/openfl/events/KeyboardEvent.hx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class KeyboardEvent extends Event
public static inline var KEY_UP:EventType<KeyboardEvent> = "keyUp";

/**
Indicates whether the Alt key is active(`true`) or inactive
Indicates whether the Alt key is active (`true`) or inactive
(`false`) on Windows; indicates whether the Option key is
active on Mac OS.
**/
Expand All @@ -80,7 +80,7 @@ class KeyboardEvent extends Event
press Shift+3, `charCode` is # on a Japanese keyboard, just as
it is on an English keyboard.
**Note: **When an input method editor(IME) is running,
**Note:** When an input method editor (IME) is running,
`charCode` does not report accurate character codes.
**/
public var charCode:Int;
Expand All @@ -103,15 +103,15 @@ class KeyboardEvent extends Event

/**
On Windows and Linux, indicates whether the Ctrl key is active
(`true`) or inactive(`false`); On Mac OS, indicates
(`true`) or inactive (`false`); On Mac OS, indicates
whether either the Ctrl key or the Command key is active.
**/
public var ctrlKey:Bool;

/**
The key code value of the key pressed or released.
**Note: **When an input method editor(IME) is running,
**Note:** When an input method editor (IME) is running,
`keyCode` does not report accurate key codes.
**/
public var keyCode:Int;
Expand All @@ -129,8 +129,8 @@ class KeyboardEvent extends Event
public var keyLocation:KeyLocation;

/**
Indicates whether the Shift key modifier is active(`true`) or
inactive(`false`).
Indicates whether the Shift key modifier is active (`true`) or
inactive (`false`).
**/
public var shiftKey:Bool;

Expand Down
10 changes: 5 additions & 5 deletions src/openfl/events/MouseEvent.hx
Original file line number Diff line number Diff line change
Expand Up @@ -456,15 +456,15 @@ class MouseEvent extends Event
public static inline var ROLL_OVER:EventType<MouseEvent> = "rollOver";

/**
Indicates whether the Alt key is active(`true`) or inactive
Indicates whether the Alt key is active (`true`) or inactive
(`false`). Supported for Windows only. On other operating
systems, this property is always set to `false`.
**/
public var altKey:Bool;

/**
Indicates whether the primary mouse button is pressed(`true`)
or not(`false`).
Indicates whether the primary mouse button is pressed (`true`)
or not (`false`).
**/
public var buttonDown:Bool;

Expand Down Expand Up @@ -500,7 +500,7 @@ class MouseEvent extends Event

/**
On Windows or Linux, indicates whether the Ctrl key is active
(`true`) or inactive(`false`). On Macintosh,
(`true`) or inactive (`false`). On Macintosh,
indicates whether either the Control key or the Command key is activated.
**/
public var ctrlKey:Bool;
Expand Down Expand Up @@ -558,7 +558,7 @@ class MouseEvent extends Event
public var relatedObject:InteractiveObject;

/**
Indicates whether the Shift key is active(`true`) or inactive
Indicates whether the Shift key is active (`true`) or inactive
(`false`).
**/
public var shiftKey:Bool;
Expand Down
6 changes: 3 additions & 3 deletions src/openfl/events/TouchEvent.hx
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ class TouchEvent extends Event
public static inline var TOUCH_TAP:EventType<TouchEvent> = "touchTap";

/**
Indicates whether the Alt key is active(`true`) or inactive
Indicates whether the Alt key is active (`true`) or inactive
(`false`). Supported for Windows and Linux operating systems
only.
**/
Expand All @@ -312,7 +312,7 @@ class TouchEvent extends Event

/**
On Windows or Linux, indicates whether the Ctrl key is active
(`true`) or inactive(`false`). On Macintosh,
(`true`) or inactive (`false`). On Macintosh,
indicates whether either the Control key or the Command key is activated.
**/
public var ctrlKey:Bool;
Expand Down Expand Up @@ -374,7 +374,7 @@ class TouchEvent extends Event
public var relatedObject:InteractiveObject;

/**
Indicates whether the Shift key is active(`true`) or inactive
Indicates whether the Shift key is active (`true`) or inactive
(`false`).
**/
public var shiftKey:Bool;
Expand Down
8 changes: 3 additions & 5 deletions src/openfl/filters/DropShadowFilter.hx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import openfl.geom.Rectangle;
import lime._internal.graphics.ImageDataUtil; // TODO

#end

/**
The DropShadowFilter class lets you add a drop shadow to display objects.
The shadow algorithm is based on the same box filter that the blur filter
Expand Down Expand Up @@ -122,7 +121,7 @@ import lime._internal.graphics.ImageDataUtil; // TODO
public var inner(get, set):Bool;

/**
Applies a knockout effect(`true`), which effectively makes the
Applies a knockout effect (`true`), which effectively makes the
object's fill transparent and reveals the background color of the
document. The default is `false`(no knockout).
**/
Expand Down Expand Up @@ -251,7 +250,7 @@ import lime._internal.graphics.ImageDataUtil; // TODO
A value of `true` specifies an inner shadow.
A value of `false` specifies an outer shadow
(a shadow around the outer edges of the object).
@param knockout Applies a knockout effect(`true`), which
@param knockout Applies a knockout effect (`true`), which
effectively makes the object's fill transparent and
reveals the background color of the document.
@param hideObject Indicates whether or not the object is hidden. A value
Expand Down Expand Up @@ -290,8 +289,7 @@ import lime._internal.graphics.ImageDataUtil; // TODO
return new DropShadowFilter(__distance, __angle, __color, __alpha, __blurX, __blurY, __strength, __quality, __inner, __knockout, __hideObject);
}

@:noCompletion private override function __applyFilter(bitmapData:BitmapData, sourceBitmapData:BitmapData, sourceRect:Rectangle,
destPoint:Point):BitmapData
@:noCompletion private override function __applyFilter(bitmapData:BitmapData, sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point):BitmapData
{
// TODO: Support knockout, inner

Expand Down
2 changes: 1 addition & 1 deletion src/openfl/sensors/Accelerometer.hx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class Accelerometer extends EventDispatcher

/**
Specifies whether the user has denied access to the accelerometer
(`true`) or allowed access(`false`). When this
(`true`) or allowed access (`false`). When this
value changes, a `status` event is dispatched.
**/
public var muted(get, set):Bool;
Expand Down
36 changes: 18 additions & 18 deletions src/openfl/system/Capabilities.hx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ import sys.io.Process;
{
/**
Specifies whether access to the user's camera and microphone has been
administratively prohibited(`true`) or allowed
administratively prohibited (`true`) or allowed
(`false`). The server string is `AVD`.
For content in Adobe AIR™, this property applies only to content in
Expand All @@ -116,8 +116,8 @@ import sys.io.Process;
public static var cpuArchitecture(get, never):String;

/**
Specifies whether the system supports(`true`) or does not
support(`false`) communication with accessibility aids. The
Specifies whether the system supports (`true`) or does not
support (`false`) communication with accessibility aids. The
server string is `ACC`.
**/
public static var hasAccessibility(default, null) = false;
Expand All @@ -129,79 +129,79 @@ import sys.io.Process;
public static var hasAudio(default, null) = true;

/**
Specifies whether the system can(`true`) or cannot
Specifies whether the system can (`true`) or cannot
(`false`) encode an audio stream, such as that coming from a
microphone. The server string is `AE`.
**/
public static var hasAudioEncoder(default, null) = false;

/**
Specifies whether the system supports(`true`) or does not
support(`false`) embedded video. The server string is
Specifies whether the system supports (`true`) or does not
support (`false`) embedded video. The server string is
`EV`.
**/
public static var hasEmbeddedVideo(default, null) = false;

/**
Specifies whether the system does(`true`) or does not
(`false`) have an input method editor(IME) installed. The
Specifies whether the system does (`true`) or does not
(`false`) have an input method editor (IME) installed. The
server string is `IME`.
**/
public static var hasIME(default, null) = false;

/**
Specifies whether the system does(`true`) or does not
Specifies whether the system does (`true`) or does not
(`false`) have an MP3 decoder. The server string is
`MP3`.
**/
public static var hasMP3(default, null) = false;

/**
Specifies whether the system does(`true`) or does not
Specifies whether the system does (`true`) or does not
(`false`) support printing. The server string is
`PR`.
**/
public static var hasPrinting(default, null) = #if html5 true #else false #end;

/**
Specifies whether the system does(`true`) or does not
Specifies whether the system does (`true`) or does not
(`false`) support the development of screen broadcast
applications to be run through Flash Media Server. The server string is
`SB`.
**/
public static var hasScreenBroadcast(default, null) = false;

/**
Specifies whether the system does(`true`) or does not
Specifies whether the system does (`true`) or does not
(`false`) support the playback of screen broadcast applications
that are being run through Flash Media Server. The server string is
`SP`.
**/
public static var hasScreenPlayback(default, null) = false;

/**
Specifies whether the system can(`true`) or cannot
Specifies whether the system can (`true`) or cannot
(`false`) play streaming audio. The server string is
`SA`.
**/
public static var hasStreamingAudio(default, null) = false;

/**
Specifies whether the system can(`true`) or cannot
Specifies whether the system can (`true`) or cannot
(`false`) play streaming video. The server string is
`SV`.
**/
public static var hasStreamingVideo(default, null) = false;

/**
Specifies whether the system supports native SSL sockets through
NetConnection(`true`) or does not(`false`). The
NetConnection (`true`) or does not (`false`). The
server string is `TLS`.
**/
public static var hasTLS(default, null) = true;

/**
Specifies whether the system can(`true`) or cannot
Specifies whether the system can (`true`) or cannot
(`false`) encode a video stream, such as that coming from a web
camera. The server string is `VE`.
**/
Expand All @@ -218,7 +218,7 @@ import sys.io.Process;

/**
Specifies whether the Flash runtime is embedded in a PDF file that is open
in Acrobat 9.0 or higher(`true`) or not(`false`).
in Acrobat 9.0 or higher (`true`) or not (`false`).
**/
public static var isEmbeddedInAcrobat(default, null) = false;

Expand Down Expand Up @@ -271,7 +271,7 @@ import sys.io.Process;

/**
Specifies whether read access to the user's hard disk has been
administratively prohibited(`true`) or allowed
administratively prohibited (`true`) or allowed
(`false`). For content in Adobe AIR, this property applies only
to content in security sandboxes other than the application security
sandbox.(Content in the application security sandbox can always read from
Expand Down

0 comments on commit 7ae1be7

Please sign in to comment.