Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix some doc errors #13978

Merged
merged 1 commit into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apidoc/Titanium/Android/Menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ description: |
Menus must be added to tab groups using the tab group's
activity. These changes were required to support the Android 3.0 action bar.

The TabGroup activity is available using [TabGroup.getActivity](Titanium.UI.TabGroup.getActivity).
The TabGroup activity is available using [TabGroup.activity](Titanium.UI.TabGroup.activity).
However, unlike a window's activity it is not currently possible to set properties on
the tab group's activity before the tab group is opened. To add a menu to a tab group,
set the `onCreateOptionsMenu` property to the tab group's `open` event listener, and
Expand Down
2 changes: 1 addition & 1 deletion apidoc/Titanium/Calendar/Calendar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |

#### Android
On Android, calendar permissions must be explicitly configured in `tiapp.xml` in order to access the
calendar and you have to use [requestCalendarPermissions](Titanium.Calendar.requestcalendarpermissions)
calendar and you have to use [requestCalendarPermissions](Titanium.Calendar.requestCalendarPermissions)
to request runtime permissions.

``` xml
Expand Down
2 changes: 1 addition & 1 deletion apidoc/Titanium/UI/Android/CollapseToolbar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ excludes:
events: [click, dblclick, doubletap, focus, keypressed, longclick, longpress, pinch, postlayout,
singletap, swipe, touchcancel, touchend, touchmove, touchstart, twofingertap]
methods: [add, animate, convertPointToView, remove, removeAllChildren, toImage, addEventListener, applyProperties,
fireEvent, getViewById, hide, insertAt, removeEventListener, replaceAt, show, startLayout, updateLayout]
fireEvent, getViewById, hide, insertAt, removeEventListener, replaceAt, show]
properties: [accessibilityHidden, accessibilityHint, accessibilityLabel, accessibilityValue,
anchorPoint, animatedCenter, backgroundColor, backgroundDisabledColor,
backgroundDisabledImage, backgroundFocusedColor, backgroundFocusedImage, backgroundGradient,
Expand Down
4 changes: 2 additions & 2 deletions apidoc/Titanium/UI/PickerColumn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ excludes:
touchFeedback, touchFeedbackColor, transform, translationX, translationY, translationZ,
transitionName, verticalMotionEffect, viewShadowRadius, viewShadowColor, viewShadowOffset,
visible, width, horizontalWrap, keepScreenOn, tintColor, zIndex]
methods: [add, animate, clearMotionEffects, finishLayout, hide, insertAt, remove,
removeAllChildren, replaceAt, show, startLayout, toImage, updateLayout, convertPointToView,
methods: [add, animate, clearMotionEffects, hide, insertAt, remove,
removeAllChildren, replaceAt, show, toImage, convertPointToView,
getViewById]
events: [click, dblclick, doubletap, keypressed, longpress, pinch, singletap, swipe, touchcancel,
touchend, touchmove, touchstart, twofingertap]
Expand Down
2 changes: 1 addition & 1 deletion apidoc/Titanium/UI/SearchBar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: |
Search bars are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView) and
[ListView](Titanium.UI.ListView). You can add a search bar to a table view via its
[search](Titanium.UI.TableView.search) property. You can add a search bar to a list view via its
[searchView](Titanium.UI.TableView.searchView) property.
[searchBar](Titanium.UI.SearchBar) property.

A search bar can also be used on its own.

Expand Down
41 changes: 0 additions & 41 deletions apidoc/Titanium/UI/Tab.yml
Original file line number Diff line number Diff line change
Expand Up @@ -329,26 +329,6 @@ properties:
availability: creation

events:
- name: blur
summary: Fired when the tab loses focus.
deprecated:
since: "5.2.0"
removed: "9.0.0"
notes: Use [Titanium.UI.Tab.unselected](Titanium.UI.Tab.unselected) event instead.
properties:
- name: index
summary: Index of the current active tab.
type: Number
- name: previousIndex
summary: Index of the previous active tab.
type: Number
- name: tab
summary: Current active tab object.
type: Titanium.UI.Tab
- name: previousTab
summary: Previous active tab object.
type: Titanium.UI.Tab
platforms: [android, iphone, ipad]

- name: unselected
summary: Fired when the tab is no longer selected.
Expand All @@ -372,27 +352,6 @@ events:
summary: Fired when this tab is clicked in the tab group.
exclude-platforms: [iphone, ipad, macos]

- name: focus
summary: Fired when the tab gains focus.
deprecated:
since: "5.2.0"
removed: "9.0.0"
notes: Use [Titanium.UI.Tab.selected](Titanium.UI.Tab.selected) event instead.
properties:
- name: index
summary: Index of the current active tab.
type: Number
- name: previousIndex
summary: Index of the previous active tab.
type: Number
- name: tab
summary: Current active tab object.
type: Titanium.UI.Tab
- name: previousTab
summary: Previous active tab object.
type: Titanium.UI.Tab
platforms: [android, iphone, ipad]

- name: selected
summary: Fired when the tab is selected.
since: {android: "3.5.1", iphone: "5.2.0", ipad: "5.2.0"}
Expand Down
67 changes: 0 additions & 67 deletions apidoc/Titanium/UI/View.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1024,38 +1024,6 @@ methods:
default: "{ animated: false }"
# FIXME: Support platfroms/osver/since on parameters!

- name: startLayout
summary: Starts a batch update of this view's layout properties.
description: |
To prevent a layout pass each time a property is modified, call `startLayout` before
changing any properties that may change this view's layout. This initiates a batch update
mode where layout changes are deferred.

Call [finishLayout](Titanium.UI.View.finishLayout) to end batch update mode and trigger a
layout pass. For example:

``` js
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
```

Note that _any_ property changes made during the batch update _may_ be deferred until
`finishLayout` is called. This may vary somewhat by platform. For example, changing the
text of a label may trigger a layout pass. In iOS, updating the label text is
deferred.

See also: [updateLayout](Titanium.UI.View.updateLayout),
[finishLayout](Titanium.UI.View.finishLayout),
[postlayout](Titanium.UI.View.postlayout) event.
since: "2.0.0"
exclude-platforms: [macos]
deprecated:
since: "3.0.0"
removed: "9.0.0"
notes: Use the [Titanium.Proxy.applyProperties](Titanium.Proxy.applyProperties) method to batch-update layout properties.

- name: stopAnimation
summary: Stops a running animation.
description: |
Expand Down Expand Up @@ -1088,41 +1056,6 @@ methods:
default: false
optional: true

- name: updateLayout
summary: |
Performs a batch update of all supplied layout properties and schedules a layout pass after
they have been updated.
description: |
This is another way to perform a batch update. The `updateLayout` method is called with a
dictionary of layout properties to perform the batch update. For example:

``` js
view.updateLayout({top:50, left:50});
```

This is equivalent to the following:

``` js
view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();
```

See also: [startLayout](Titanium.UI.View.startLayout),
[finishLayout](Titanium.UI.View.finishLayout),
[postlayout](Titanium.UI.View.postlayout) event.
since: "2.0.0"
exclude-platforms: [macos]
deprecated:
since: "3.0.0"
removed: "9.0.0"
notes: Use the [Titanium.Proxy.applyProperties](Titanium.Proxy.applyProperties) method to batch-update layout properties.
parameters:
- name: params
summary: Layout properties to be updated.
type: Dictionary

- name: convertPointToView
summary: |
Translates a point from this view's coordinate system to another view's coordinate system.
Expand Down
51 changes: 0 additions & 51 deletions apidoc/Titanium/Yahoo/Yahoo.yml

This file was deleted.

Loading