diff options
author | Mike Norman <mknorman@gmail.com> | 2017-05-09 10:51:19 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-05-09 10:51:19 -0500 |
commit | d6adff2e414fc73ea081a150092b2efd2a54f03e (patch) | |
tree | f2a38299f7a4b314ca11c71a5639498b0f7c037c /docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml | |
parent | ba06e2b20dbbb82dafacf63dd3e3e1810d976a56 (diff) | |
download | xamarin-forms-d6adff2e414fc73ea081a150092b2efd2a54f03e.tar.gz xamarin-forms-d6adff2e414fc73ea081a150092b2efd2a54f03e.tar.bz2 xamarin-forms-d6adff2e414fc73ea081a150092b2efd2a54f03e.zip |
Docs mop up (#908)
* Marked as internal those types that have EditorBrowsableState.Never
* Small Device and FileImageSource doc changes & marked I*Controller topics internal
* Mopped up few remaining missing summaries.
* Run mdoc after build
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml')
-rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml index 3023552b..ea16a2fa 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/IMultiPageController`1.xml @@ -10,8 +10,8 @@ </TypeParameters> <Interfaces /> <Docs> - <typeparam name="T">To be added.</typeparam> - <summary>To be added.</summary> + <typeparam name="T">The type of page element that the multipage controller will manage.</typeparam> + <summary>Base class for multipage controllers.</summary> <remarks>To be added.</remarks> </Docs> <Members> @@ -29,10 +29,10 @@ <Parameter Name="index" Type="System.Int32" /> </Parameters> <Docs> - <param name="index">To be added.</param> - <summary>To be added.</summary> - <returns>To be added.</returns> - <remarks>To be added.</remarks> + <param name="index">The index of the page to return.</param> + <summary>Returns the page that is identified by the provided <paramref name="index" />.</summary> + <returns>The specified page, or <see langword="null" /> if there is no page for the provided <paramref name="index" />.</returns> + <remarks>This method does not throw an exception if the provided <paramref name="index" /> is out of range. Instead, it returns <see langword="null" /> in that case.</remarks> </Docs> </Member> </Members> |