diff options
| author | Mike Norman <mknorman@gmail.com> | 2016-06-09 13:34:41 -0500 |
|---|---|---|
| committer | Mike Norman <mknorman@gmail.com> | 2016-06-09 13:34:41 -0500 |
| commit | e7be3c5504e25c0c3cfa3bb1f53e5fe569e68fad (patch) | |
| tree | 2052434b29a617939da058d8c72885193260fa74 | |
| parent | e2e303654e76eaf79fa4b1629df1f2b351fa9fcd (diff) | |
| download | xamarin-forms-e7be3c5504e25c0c3cfa3bb1f53e5fe569e68fad.tar.gz xamarin-forms-e7be3c5504e25c0c3cfa3bb1f53e5fe569e68fad.tar.bz2 xamarin-forms-e7be3c5504e25c0c3cfa3bb1f53e5fe569e68fad.zip | |
DataPages docs. (#212)
* DataPages docs.
* Summary complete for Pages docs.
* Type fixes per samhouts.
* Typos in Pages docs.
20 files changed, 273 insertions, 273 deletions
diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/BaseDataSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/BaseDataSource.xml index 625ca69f..4d86de5d 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/BaseDataSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/BaseDataSource.xml @@ -17,7 +17,7 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> + <summary>Base class for data sources.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -30,7 +30,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty data source.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -45,8 +45,8 @@ <ReturnType>System.Collections.Generic.IReadOnlyList<Xamarin.Forms.Pages.IDataItem></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the enumerable list of data items in the data source.</summary> + <value>The enumerable list of data items in the data source.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -62,8 +62,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Gets a list of the underlying data for the data source.</summary> + <returns>The list of the underlying data for the data source.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -81,9 +81,9 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="key">The key that identifies the value to get.</param> + <summary>Returns the value that is identified by <paramref name="key" />.</summary> + <returns>The value that is identified by <paramref name="key" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -98,8 +98,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets a value that is <see langword="true" /> if the data is loading, or <see langword="false" /> if it is finished loading or has not begun to load.</summary> + <value><see langword="true" /> if the data is loading, or <see langword="false" /> if it is finished loading or has not begun to load.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -117,9 +117,9 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> - <value>To be added.</value> + <param name="key">The key for the data item to get or set.</param> + <summary>Gets or sets the data item that is identified by <paramref nam="key" />.</summary> + <value>The data item that is identified by <paramref nam="key" />.</value>> <remarks>To be added.</remarks> </Docs> </Member> @@ -143,8 +143,8 @@ </Parameter> </Parameters> <Docs> - <param name="property">To be added.</param> - <summary>To be added.</summary> + <param name="property">The property that was changed.</param> + <summary>Method that is called when a monitored property is changed.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -163,10 +163,10 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="key">The identifier for the data item to change.</param> + <param name="value">The new value.</param> + <summary>Sets the data that is identified by <paramref name="key" /> to <paramref name="value" /> and calls the <see cref="M:Xamarin.Forms.Pages.BaseDataSource.OnPropertyChanged" /> method if <paramref name="value" /> is different from the current value.</summary> + <returns><see langword="false" /> if the new value is the same as the old value. Otherwise, <see langword="true" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -181,7 +181,7 @@ <ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>For internal use.</summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> @@ -209,7 +209,7 @@ </Parameters> <Docs> <param name="key">To be added.</param> - <summary>To be added.</summary> + <summary>For internal use.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -236,7 +236,7 @@ </Parameters> <Docs> <param name="key">To be added.</param> - <summary>To be added.</summary> + <summary>For internal use.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CardView.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CardView.xml index aed029ae..e57c3f84 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CardView.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CardView.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>A view that contains an image, text, and detail text.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty card view.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the detailed description of the card view.</summary> + <value>The detailed description of the card view.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.CardView.Detail" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,8 +69,8 @@ <ReturnType>Xamarin.Forms.ImageSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image for the card view.</summary> + <value>The image for the card view.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.CardView.ImageSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -100,8 +100,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets a brief description of the card view.</summary> + <value>The brief description of the card view.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -116,7 +116,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.CardView.Text" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CompoundCollection.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CompoundCollection.xml index 37c7873c..a6705858 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CompoundCollection.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/CompoundCollection.xml @@ -17,7 +17,7 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> + <summary>A collection that consists of prepended items, a main list, and appended items.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -30,7 +30,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty compound collection.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -49,7 +49,7 @@ </Parameters> <Docs> <param name="value">To be added.</param> - <summary>To be added.</summary> + <summary>Not supported.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> @@ -65,8 +65,8 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the list of appended items.</summary> + <value>The list of appended items.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -82,7 +82,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Not supported.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -97,7 +97,7 @@ <ReturnType>System.Collections.Specialized.NotifyCollectionChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Event that is raised when the collection is changed.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -115,9 +115,9 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="value">The value to check.</param> + <summary>Returns <see langword="true" /> if <paramref name="value" /> is contained in the compound collection. Otherwise, returns <see langword="false" />.</summary> + <returns><see langword="true" /> if <paramref name="value" /> is contained in the compound collection. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -138,7 +138,7 @@ <Docs> <param name="array">To be added.</param> <param name="index">To be added.</param> - <summary>To be added.</summary> + <summary>Not supported.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -153,8 +153,8 @@ <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the number of items in the compound collection.</summary> + <value>The number of items in the compound collection.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -170,8 +170,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Gets an enumerator for iterating over the objects in the compound collection.</summary> + <returns>The enumerator for iterating over the objects in the compound collection.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -189,9 +189,9 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="value">The value for which to locate the first index at which it appears.</param> + <summary>Finds the first index where the value appears, or -1 if the object is not present in the compound collection.</summary> + <returns>The first index where the value appears, or -1 if the object is not present in the compound collection.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -212,7 +212,7 @@ <Docs> <param name="index">To be added.</param> <param name="value">To be added.</param> - <summary>To be added.</summary> + <summary>Not supported.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -227,8 +227,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Returns <see langword="false" />.</summary> + <value><see langword="false" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -243,8 +243,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Returns <see langword="true" />.</summary> + <value><see langword="true" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -259,8 +259,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Returns <see langword="false" />.</summary> + <value><see langword="false" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -279,8 +279,8 @@ </Parameters> <Docs> <param name="index">To be added.</param> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the item at the specified <paramref name="index" />. Setting is not supported.</summary> + <value>When used as an rvalue, the item at the specified <paramref name="index" />. Use as an lvalue is not supported.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -295,8 +295,8 @@ <ReturnType>System.Collections.Generic.IReadOnlyList<System.Object></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the unappended list.</summary> + <value>The unappended list.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -311,7 +311,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.CompoundCollection.MainList" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -326,8 +326,8 @@ <ReturnType>System.Collections.IList</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the list of prepended items.</summary> + <value>The list of prepended items.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -346,7 +346,7 @@ </Parameters> <Docs> <param name="value">To be added.</param> - <summary>To be added.</summary> + <summary>Not supported.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -365,7 +365,7 @@ </Parameters> <Docs> <param name="index">To be added.</param> - <summary>To be added.</summary> + <summary>Not supported.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -380,8 +380,8 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Returns <see langword="null" />.</summary> + <value><see langword="null" />.</value> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataItem.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataItem.xml index d0a71f8e..6ae299be 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataItem.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataItem.xml @@ -17,7 +17,7 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> + <summary>An item of data for display in a data page.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -30,7 +30,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty <see cref="T:Xamarin.Forms.Pages.DataItem" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -46,9 +46,9 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="name">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> + <param name="name">The name, or key, for the data item.</param> + <param name="value">The value of the data item.</param> + <summary>Creates a new data item with the specified name and value.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -66,9 +66,9 @@ <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> - <param name="obj">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="obj">The object to compare to the current object.</param> + <summary>Returns <see langword="true" /> if <paramref name="obj" /> is the same object as the current data item, or if it is another <see cref="T:Xamarin.Forms.Pages.DataItem" /> that contains the same name and value. Otherwise, returns <see langword="false" />.</summary> + <returns><see langword="true" /> if <paramref name="obj" /> is the same object as the current data item, or if it is another <see cref="T:Xamarin.Forms.Pages.DataItem" /> that contains the same name and value. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -86,9 +86,9 @@ <Parameter Name="other" Type="Xamarin.Forms.Pages.DataItem" /> </Parameters> <Docs> - <param name="other">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="other">The <see cref="T:Xamarin.Forms.Pages.DataItem" /> to compare to the current object.</param> + <summary>Returns <see langword="true" /> if <paramref name="other" /> contains the same name and value. Otherwise, returns <see langword="false" />.</summary> + <returns><see langword="true" /> if <paramref name="other" /> contains the same name and value. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -104,8 +104,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Returns the hash code for the combined name and value, or 0 if a hash code cannot be determined.</summary> + <returns>The hash code for the combined name and value, or 0 if a hash code cannot be determined.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,8 +120,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the name of the data item.</summary> + <value>The name of the data item.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -145,8 +145,8 @@ </Parameter> </Parameters> <Docs> - <param name="propertyName">To be added.</param> - <summary>To be added.</summary> + <param name="propertyName">The name of the property that changed.</param> + <summary>Called after either the name or property changes.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -165,10 +165,10 @@ <Parameter Name="right" Type="Xamarin.Forms.Pages.DataItem" /> </Parameters> <Docs> - <param name="left">To be added.</param> - <param name="right">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="left">The first <see cref="T:Xamarin.Forms.Pages.DataItem" /> to compare.</param> + <param name="right">The second <see cref="T:Xamarin.Forms.Pages.DataItem" /> to compare.</param> + <summary>Returns <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are the same object, or if they have the same name and value. Otherwise, returns <see langword="false" />.</summary> + <returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are the same object, or if they have the same name and value. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -187,10 +187,10 @@ <Parameter Name="right" Type="Xamarin.Forms.Pages.DataItem" /> </Parameters> <Docs> - <param name="left">To be added.</param> - <param name="right">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="left">The first <see cref="T:Xamarin.Forms.Pages.DataItem" /> to compare.</param> + <param name="right">The second <see cref="T:Xamarin.Forms.Pages.DataItem" /> to compare.</param> + <summary>Returns <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not the same object, or if they are the same object, but have different names or values. Otherwise, returns <see langword="false" />.</summary> + <returns><see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> are not the same object, or if they are the same object, but have different names or values. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -205,7 +205,7 @@ <ReturnType>System.ComponentModel.PropertyChangedEventHandler</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Event that is raised when the name or value is changed.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -220,8 +220,8 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the value of the data item.</summary> + <value>The value of the data item.</value> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataPage.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataPage.xml index 6b60fdfc..5731d9a0 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataPage.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataPage.xml @@ -14,7 +14,7 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> + <summary>Base class for <see cref="T:Xamarin.Forms.Pages.DirectoryPage" />, <see cref="T:Xamarin.Forms.Pages.ListDataPage" />, and <see cref="T:Xamarin.Forms.Pages.PersonDetailPage" />, and for data pages defined by the developer .</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new DataPage with default values.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -42,8 +42,8 @@ <ReturnType>System.Collections.Generic.IEnumerable<Xamarin.Forms.Pages.IDataItem></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the data that will be displayed by the data page.</summary> + <value>The data that will be displayed by the data page.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -58,7 +58,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataPage.Data" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -73,8 +73,8 @@ <ReturnType>Xamarin.Forms.Pages.IDataSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets a data source, such as a URL or file, from which an enumerable list of <see cref="T:Xamarin.Forms.Pages.IDataItem" /> objects can be obtained.</summary> + <value>The data source from which an enumerable list of <see cref="T:Xamarin.Forms.Pages.IDataItem" /> objects can be obtained.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -89,7 +89,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataPage.DataSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -104,8 +104,8 @@ <ReturnType>Xamarin.Forms.DataTemplate</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the <see cref="T:Xamarin.Forms.DataTemplate" /> to use when none is specified by a <see cref="T:Xamarin.Forms.DataTemplateSelector" />.</summary> + <value>The <see cref="T:Xamarin.Forms.DataTemplate" /> to use when none is specified by a <see cref="T:Xamarin.Forms.DataTemplateSelector" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,7 +120,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataPage.DefaultItemTemplate" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -138,8 +138,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key of the key-value pair to suppress from the data source.</param> + <summary>Makes a data key unavailable to the application.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -157,8 +157,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key of the previously masked key-value pair to make available to the application.</param> + <summary>Makes a previously masked data key available to the application.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataView.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataView.xml index d0108ba1..92a10c2c 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataView.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DataView.xml @@ -14,7 +14,7 @@ </Interface> </Interfaces> <Docs> - <summary>To be added.</summary> + <summary>Supports data presentation, and is the base class for <see cref="T:Xamarin.Forms.Pages.CardView" />, <see cref="T:Xamarin.Forms.Pages.HeroImage" />, and <see cref="T:Xamarin.Forms.Pages.ListItemControl" />.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -27,7 +27,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty data view.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -42,8 +42,8 @@ <ReturnType>System.Collections.Generic.IEnumerable<Xamarin.Forms.Pages.IDataItem></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the enumerable list of data to display.</summary> + <value>The enumerable list of data to display.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -58,7 +58,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataView.Data" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -73,8 +73,8 @@ <ReturnType>Xamarin.Forms.Pages.IDataSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the data source.</summary> + <value>The data source.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -89,7 +89,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataView.DataSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -104,8 +104,8 @@ <ReturnType>Xamarin.Forms.DataTemplate</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the default template to use for displaying data when none is specified by a data template selector.</summary> + <value>The default template to use for displaying data when none is specified by a data template selector.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -120,7 +120,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DataView.DefaultItemTemplate" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -138,8 +138,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to block from the application.</param> + <summary>Prevents the data item that is identified by <paramref name="key" /> from being available to the application.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -157,8 +157,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to unblock from the application</param> + <summary>Makes the previously masked data item that is identified by <paramref name="key" /> available to the application</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DirectoryPage.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DirectoryPage.xml index 1dc6016f..c33c2402 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DirectoryPage.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/DirectoryPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Displays items, optionally grouping them.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty directory page.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets a value that controls whether items will be grouped.</summary> + <value>The value that controls whether items will be grouped.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.DirectoryPage.IsGroupingEnabled" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/HeroImage.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/HeroImage.xml index 4edfad49..5bc76269 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/HeroImage.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/HeroImage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>An image data view for featuring a person or thing.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty hero image.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>Xamarin.Forms.Aspect</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image aspect, which controls clipping and filling when the image size does not match the view size.</summary> + <value>The image aspect, which controls clipping and filling when the image size does not match the view size.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.HeroImage.Aspect" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,8 +69,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the detailed description of the hero image.</summary> + <value>The detailed description of the hero image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.HeroImage.Detail" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -100,8 +100,8 @@ <ReturnType>Xamarin.Forms.ImageSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image source from which to get the hero image.</summary> + <value>The image source from which to get the hero image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -116,7 +116,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.HeroImage.ImageSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -131,8 +131,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the title, or main, text for the hero image.</summary> + <value>The title, or main, text for the hero image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -147,7 +147,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.HeroImage.Text" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataItem.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataItem.xml index 4adbba5f..876d6b07 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataItem.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataItem.xml @@ -7,7 +7,7 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>An interface that represents an item of data for display in a data page.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -22,8 +22,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the name of the data item.</summary> + <value>The name of the data item.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the value of the data item.</summary> + <value>The value of the data item.</value> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSource.xml index b50c2796..801468d8 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSource.xml @@ -7,7 +7,7 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Interface that represents a source for data to display in a data page.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -22,8 +22,8 @@ <ReturnType>System.Collections.Generic.IReadOnlyList<Xamarin.Forms.Pages.IDataItem></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets the list of data items to display.</summary> + <value>The list of data items to display.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets a value that is <see langword="true" /> if the data is loading, or <see langword="false" /> if it is finished loading or has not begun to load.</summary> + <value><see langword="true" /> if the data is loading, or <see langword="false" /> if it is finished loading or has not begun to load.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -57,9 +57,9 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> - <value>To be added.</value> + <param name="key">The key for the data item to get or set.</param> + <summary>Gets or sets the data item that is identified by <paramref nam="key" />.</summary> + <value>The data item that is identified by <paramref nam="key" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -74,8 +74,8 @@ <ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets an enumerable list of keys that have been masked with <see cref="M:Xamarin.Forms.Pages.IDataSource.MaskKey" />.</summary> + <value>The enumerable list of keys that have been masked with <see cref="M:Xamarin.Forms.Pages.IDataSource.MaskKey" />.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -93,8 +93,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to block from the application.</param> + <summary>Prevents the data item that is identified by <paramref name="key" /> from being available to the application.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -112,8 +112,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to unblock from the application</param> + <summary>Makes the previously masked data item that is identified by <paramref name="key" /> available to the application</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSourceProvider.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSourceProvider.xml index 8c75e066..c4a13ddd 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSourceProvider.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/IDataSourceProvider.xml @@ -7,7 +7,7 @@ </AssemblyInfo> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Interface that represents a data source provider.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -22,8 +22,8 @@ <ReturnType>Xamarin.Forms.Pages.IDataSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the data source.</summary> + <value>The data source.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -41,8 +41,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to block from the application.</param> + <summary>Prevents the data item that is identified by <paramref name="key" /> from being available to the application.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -60,8 +60,8 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> + <param name="key">The key for the data item to unblock from the application</param> + <summary>Makes the previously masked data item that is identified by <paramref name="key" /> available to the application</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonDataSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonDataSource.xml index b85a28a2..48430f67 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonDataSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonDataSource.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Represents a source of JSON data.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty JSON data source.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -47,8 +47,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Returns the raw JSON data from the source.</summary> + <returns>The raw JSON data from the source.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -66,9 +66,9 @@ <Parameter Name="key" Type="System.String" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="key">The key of the data to get.</param> + <summary>Returns the first data item that matches the <paramref name="key" />.</summary> + <returns>The first data item that matches the <paramref name="key" />, or <see langword="null" /> if no such item exists.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -87,10 +87,10 @@ <Parameter Name="value" Type="System.Object" /> </Parameters> <Docs> - <param name="key">To be added.</param> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="key">The key to add or modify.</param> + <param name="value">The value to assign.</param> + <summary>Assigns the data that is identified by <paramref name="key"/> to <paramref name="value" />, creating it if it does not exist.</summary> + <returns><see langword="true" /> if an existing value was modified, or if a new value was assigned to a value other than <parmamref name="null" />. Otherwise, <see langword="false" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -110,8 +110,8 @@ <ReturnType>Xamarin.Forms.Pages.JsonSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the source of the raw JSON data.</summary> + <value>The source of the raw JSON data.</value> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSource.xml index 2e1283f1..6bf5f341 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSource.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Represents a source for a JSON string.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty JSON source.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -41,9 +41,9 @@ <Parameter Name="json" Type="System.String" /> </Parameters> <Docs> - <param name="json">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="json">The JSON source string.</param> + <summary>Creates a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> from the specified <paramref name="json" /> string.</summary> + <returns>A <see cref="T:Xamarin.Forms.Pages.JsonSource" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -62,8 +62,8 @@ </Parameters> <Docs> <param name="uri">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Creates a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> from the specified <paramref name="uri" />.</summary> + <returns>A <see cref="T:Xamarin.Forms.Pages.JsonSource" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -79,8 +79,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>When implemented by the application developer, returns a task that retrieves the string representation of the JSON source.</summary> + <returns>A task that retrieves the string representation of the JSON source.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -98,9 +98,9 @@ <Parameter Name="json" Type="System.String" /> </Parameters> <Docs> - <param name="json">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="json">The JSON string to convert to a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> object.</param> + <summary>Implicitly converts a JSON string to a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> object.</summary> + <returns>A JSON string to a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> object.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSourceConverter.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSourceConverter.xml index 0e4fb602..0d5ecdba 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSourceConverter.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/JsonSourceConverter.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Converter that returns a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> for a JSON string or a URI string.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new JSON source converter.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -41,9 +41,9 @@ <Parameter Name="value" Type="System.String" /> </Parameters> <Docs> - <param name="value">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> + <param name="value">.</param> + <summary>Returns a <see cref="T:Xamarin.Forms.Pages.JsonSource" /> for an invariant JSON string or URI string.</summary> + <returns>A <see cref="T:Xamarin.Forms.Pages.JsonSource" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPage.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPage.xml index 2a96833b..e0f68dbf 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPage.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Displays ungrouped list data.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty list data page.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>Xamarin.Forms.DataTemplate</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the template to use when formatting the detail text.</summary> + <value>The template to use when formatting the detail text.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListDataPage.DetailTemplate" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,8 +69,8 @@ <ReturnType>System.Object</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the selected item in the list.</summary> + <value>The selected item in the list.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListDataPage.SelectedItem" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPageControl.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPageControl.xml index 9cefed5e..59485c6b 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPageControl.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListDataPageControl.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Page control for list data.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates a new list data page control.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListItemControl.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListItemControl.xml index d5092860..ed8fc5b0 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListItemControl.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/ListItemControl.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Control for displaying list items.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty list item control.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>Xamarin.Forms.Aspect</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image aspect, which controls clipping and filling when the image size does not match the view size.</summary> + <value>The image aspect, which controls clipping and filling when the image size does not match the view size.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListItemControl.Aspect" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,8 +69,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the detailed description of the list item image.</summary> + <value>The detailed description of the list item image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListItemControl.Detail" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -100,8 +100,8 @@ <ReturnType>Xamarin.Forms.ImageSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image source from which to get the list item image.</summary> + <value>The image source from which to get the list item image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -116,7 +116,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListItemControl.ImageSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -131,8 +131,8 @@ <ReturnType>Xamarin.Forms.ImageSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image source from which to get the placeholder image.</summary> + <value>The image source from which to get the placeholder image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -147,7 +147,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListItemControl.PlaceHolderImageSource" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -162,8 +162,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the title text for the list item image.</summary> + <value>The title text for the list item image.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -178,7 +178,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.ListItemControl.Title" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/PersonDetailPage.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/PersonDetailPage.xml index 85f875fe..e4dfccb9 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/PersonDetailPage.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/PersonDetailPage.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>Page for displaying details about a person, such as their name, address, email address, and so on.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty person detail page.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -38,8 +38,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the person's address.</summary> + <value>The person's address.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -54,7 +54,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Address" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -69,8 +69,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the name of the person for display.</summary> + <value>The name of the person for display.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -85,7 +85,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.DisplayName" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -100,8 +100,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the person's email address.</summary> + <value>The person's email address.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -116,7 +116,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Email" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -131,8 +131,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the person's employer.</summary> + <value>The person's employer.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -147,7 +147,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Employer" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -162,8 +162,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>The person's Facebook URL.</summary> + <value>The person's Facebook URL.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -178,7 +178,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Facebook" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -193,8 +193,8 @@ <ReturnType>Xamarin.Forms.ImageSource</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the image of the person.</summary> + <value>The image of the person.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -209,7 +209,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Image" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -224,8 +224,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the person's phone number.</summary> + <value>The person's phone number.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -240,7 +240,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.PhoneNumber" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -255,8 +255,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the person's twitter handle.</summary> + <value>The person's twitter handle.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -271,7 +271,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Twitter" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -286,8 +286,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the URL to the person's website.</summary> + <value>The URL to the person's website.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -302,7 +302,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.PersonDetailPage.Website" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/StringJsonSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/StringJsonSource.xml index c6641187..7d5df229 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/StringJsonSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/StringJsonSource.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>A JSON source that sources its data from a string.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty string JSON source</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -39,8 +39,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Returns a task that gets the string representation of the JSON in the string JSON source.</summary> + <returns>A task that gets the string representation of the JSON in the string JSON source.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -55,8 +55,8 @@ <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the string representation of the JSON in the string JSON source.</summary> + <value>The string representation of the JSON in the string JSON source.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -71,7 +71,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.StringJsonSource.Json" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> diff --git a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/UriJsonSource.xml b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/UriJsonSource.xml index 0d0f6a9a..81718d86 100644 --- a/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/UriJsonSource.xml +++ b/docs/Xamarin.Forms.Pages/Xamarin.Forms.Pages/UriJsonSource.xml @@ -10,7 +10,7 @@ </Base> <Interfaces /> <Docs> - <summary>To be added.</summary> + <summary>A JSON source that sources its data from a URI.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -23,7 +23,7 @@ </AssemblyInfo> <Parameters /> <Docs> - <summary>To be added.</summary> + <summary>Creates an empty URI JSON source.</summary> <remarks>To be added.</remarks> </Docs> </Member> @@ -47,8 +47,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added.</summary> - <returns>To be added.</returns> + <summary>Returns a task that gets the string representation of the JSON in the URI JSON source.</summary> + <returns>A task that gets the string representation of the JSON in the URI JSON source.</returns> <remarks>To be added.</remarks> </Docs> </Member> @@ -68,8 +68,8 @@ <ReturnType>System.Uri</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> - <value>To be added.</value> + <summary>Gets or sets the URI from which to source the JSON data.</summary> + <value>The URI from which to source the JSON data.</value> <remarks>To be added.</remarks> </Docs> </Member> @@ -84,7 +84,7 @@ <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> </ReturnValue> <Docs> - <summary>To be added.</summary> + <summary>Backing store for the <see cref="P:Xamarin.Forms.Pages.UriJsonSource.Uri" /> property.</summary> <remarks>To be added.</remarks> </Docs> </Member> |