Skip to content

[src] Import xml docs for members, part 20. #22658

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 24, 2025
Merged

[src] Import xml docs for members, part 20. #22658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions docs/api/EventKit/EKRecurrenceRule.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<Documentation>
<Docs DocId="M:EventKit.EKRecurrenceRule.#ctor(EventKit.EKRecurrenceFrequency,System.IntPtr,EventKit.EKRecurrenceDayOfWeek[],Foundation.NSNumber[],Foundation.NSNumber[],Foundation.NSNumber[],Foundation.NSNumber[],Foundation.NSNumber[],EventKit.EKRecurrenceEnd)">
<param name="type">To be added.</param>
<param name="interval">To be added.</param>
<param name="days">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="monthDays">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="months">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="weeksOfTheYear">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="daysOfTheYear">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="setPositions">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="end">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Documentation>
64 changes: 44 additions & 20 deletions docs/api/Foundation/NSAttributedString.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,31 +131,31 @@ var text = new NSAttributedString (
<related type="externalDocumentation" href="https://developer.apple.com/library/ios/documentation/Cocoa/Reference/Foundation/Classes/NSAttributedString_Class/index.html">Apple documentation for <c>NSAttributedString</c></related>
</Docs>
<Docs DocId="M:Foundation.NSAttributedString.#ctor(System.String,UIKit.UIFont,UIKit.UIColor,UIKit.UIColor,UIKit.UIColor,UIKit.NSParagraphStyle,Foundation.NSLigatureType,System.Single,Foundation.NSUnderlineStyle,UIKit.NSShadow,System.Single,Foundation.NSUnderlineStyle)">
<param name="str">String to create.</param>
<param name="font">Desired font (or null, if none is desired).</param>
<param name="foregroundColor">Desired foreground color (or null if none is desired).</param>
<param name="backgroundColor">Desired background color (or null if none is desired)..</param>
<param name="strokeColor">Desired stroke color (or null if none is desired).</param>
<param name="paragraphStyle">To be added.</param>
<param name="ligatures">To be added.</param>
<param name="kerning">To be added.</param>
<param name="underlineStyle">To be added.</param>
<param name="shadow">Desired shadow.</param>
<param name="strokeWidth">Desired stroked width..</param>
<param name="strikethroughStyle">To be added.</param>
<summary>Creates a UIKit attributed string with the specified attributes in the parameters.</summary>
<remarks>
<para>
<param name="str">String to create.</param>
<param name="font">Desired font (or null, if none is desired).</param>
<param name="foregroundColor">Desired foreground color (or null if none is desired).</param>
<param name="backgroundColor">Desired background color (or null if none is desired)..</param>
<param name="strokeColor">Desired stroke color (or null if none is desired).</param>
<param name="paragraphStyle">To be added.</param>
<param name="ligatures">To be added.</param>
<param name="kerning">To be added.</param>
<param name="underlineStyle">To be added.</param>
<param name="shadow">Desired shadow.</param>
<param name="strokeWidth">Desired stroked width..</param>
<param name="strikethroughStyle">To be added.</param>
<summary>Creates a UIKit attributed string with the specified attributes in the parameters.</summary>
<remarks>
<para>
This is the recommended constructor for NSAttributedString
objects that are intended to be unique.
</para>
<para>
<para>
The advantage of this constructor is that other than the
string, every parameter is optional. It provides a
convenient way of creating the objects
</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// This example shows how to create an NSAttributedString for
// use with UIKit without creating the attributes separately
Expand All @@ -167,15 +167,39 @@ var text = new NSAttributedString (
strokeWidth: 4
);
]]></code>
</example>
<para>
</example>
<para>
For cases where the same attributes will be reused across
multiple attributed strings, it is best to create the
attributes using the UIStringAttributes class as that will
share the same dictionary across multiple uses while this
constructor creates a dictionary on demand for the
specified attributes in the constructor.
</para>
</remarks>
</Docs>
<Docs DocId="M:Foundation.NSAttributedString.LowLevelGetAttributes(System.IntPtr,Foundation.NSRange@)">
<param name="location">The location to probe.</param>
<param name="effectiveRange">The range to probe.</param>
<summary>Low-level version that provides an NSDictionary for the attributes in the specified range.</summary>
<returns>IntPtr handle to a native NSDictionary class.</returns>
<remarks>
<para>
In general, you should use the <see cref="M:Foundation.NSAttributedString.LowLevelGetAttributes(System.nint,Foundation.NSRange@)" />
methods, which will return a high-level NSDictionary.
</para>
<para>
This is the low-level interface to NSAttributedString and
in general is only useful for subclasses. You are
expected to return an IntPtr that represents a handle to
an NSDictionary. This API is kept as a low-level API,
since it is consumed by NSTextStorage which might call
this method thousands of times per character insertion, so
it is very important that this is kept as fast as
possible, possibly even caching or reusing existing
dictionary instances.

</para>
</remarks>
</Docs>
</Documentation>
24 changes: 24 additions & 0 deletions docs/api/Intents/INGetAvailableRestaurantReservationBookingsIntent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<Documentation>
<Docs DocId="M:Intents.INGetAvailableRestaurantReservationBookingsIntent.#ctor(Intents.INRestaurant,System.UIntPtr,Foundation.NSDateComponents,Foundation.NSNumber,Foundation.NSDate,Foundation.NSDate)">
<param name="restaurant">To be added.</param>
<param name="partySize">To be added.</param>
<param name="preferredBookingDateComponents">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="maximumNumberOfResults">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="earliestBookingDateForResults">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="latestBookingDateForResults">
<para>To be added.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<summary>Creates an intent for getting available bookings, with the specified details.</summary>
<remarks>To be added.</remarks>
</Docs>
</Documentation>
12 changes: 12 additions & 0 deletions docs/api/MapKit/MKOverlayView.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<Documentation>
<Docs DocId="M:MapKit.MKOverlayView.CanDrawMapRect(MapKit.MKMapRect,System.Runtime.InteropServices.NFloat)">
<param name="mapRect">A <see cref="T:MapKit.MKMapRect" /> representing the area to potentially be drawn.</param>
<param name="zoomScale">The current scale factor.</param>
<summary>Returns <see langword="true" /> if the <see cref="T:MapKit.MKOverlayView" /> has the data it needs to draw properly.</summary>
<returns>The default value is <see langword="true" />.</returns>
<remarks>
<para>Application developers can override this method so that it returns <see langword="false" /> until the <see cref="T:MapKit.MKOverlayView" /> has all the data it needs in order to render properly. For instance, a weather overlay might return <see langword="false" /> until it has downloaded meteorological data.</para>
<para>If application developers return <see langword="false" /> from this method, they must subsequently call <see cref="M:MapKit.MKOverlayView.SetNeedsDisplay(MapKit.MKMapRect,System.nfloat)" /> when they have received the data and performed the calculations needed to make this function return <see langword="true" />.</para>
</remarks>
</Docs>
</Documentation>
114 changes: 81 additions & 33 deletions docs/api/UIKit/NSLayoutConstraint.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,31 @@ var tconstraint1 = NSLayoutConstraint.Create (toolbar, NSLayoutAttribute.Width,
<related type="externalDocumentation" href="https://developer.apple.com/library/ios/documentation/AppKit/Reference/NSLayoutConstraint_Class/index.html">Apple documentation for <c>NSLayoutConstraint</c></related>
</Docs>
<Docs DocId="M:UIKit.NSLayoutConstraint.FromVisualFormat(System.String,UIKit.NSLayoutFormatOptions,System.Object[])">
<param name="format">Visual format to use to create the constraints.</param>
<param name="formatOptions">options.</param>
<param name="viewsAndMetrics">
<para>Pairs of names and values. The names should be strings (or NSStrings) and the values should be either UIViews, numbers (any C# number or NSNumber) or <see cref="T:ObjCRuntime.INativeObject" /> instances that are suitable to be passed to the underlying engine. </para>
<para>
</para>
<para> This binds the provided name with the view or binds the name with the number as a metric.</para>
</param>
<summary>Factory method for creating a constraint using Visual Format Language.</summary>
<returns>An array of layout constraints that are suitable to be added to a UIView using <see cref="M:UIKit.UIView.AddConstraints(UIKit.NSLayoutConstraint[])" /> method.</returns>
<remarks>
<example>
<code lang="csharp lang-csharp"><![CDATA[
<param name="format">Visual format to use to create the constraints.</param>
<param name="formatOptions">options.</param>
<param name="viewsAndMetrics">
<para>Pairs of names and values. The names should be strings (or NSStrings) and the values should be either UIViews, numbers (any C# number or NSNumber) or <see cref="T:ObjCRuntime.INativeObject" /> instances that are suitable to be passed to the underlying engine. </para>
<para>
</para>
<para> This binds the provided name with the view or binds the name with the number as a metric.</para>
</param>
<summary>Factory method for creating a constraint using Visual Format Language.</summary>
<returns>An array of layout constraints that are suitable to be added to a UIView using <see cref="M:UIKit.UIView.AddConstraints(UIKit.NSLayoutConstraint[])" /> method.</returns>
<remarks>
<example>
<code lang="csharp lang-csharp"><![CDATA[
NSLayoutConstraint.FromVisualFormat ("|-8-[messageView]-8-|", NSLayoutOptions.None, "messageView", MakeMessageView ());
]]></code>
</example>
</remarks>
</Docs>
</example>
</remarks>
</Docs>
<Docs DocId="M:UIKit.NSLayoutConstraint.ActivateConstraints(UIKit.NSLayoutConstraint[])">
<param name="constraints">Constraints to activate.</param>
<summary>Activates all of the constraints passed.</summary>
<remarks>
<para>This method has the same effect as setting the <see cref="P:UIKit.NSLayoutConstraint.Active" /> property to <see langword="true" />.</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
<param name="constraints">Constraints to activate.</param>
<summary>Activates all of the constraints passed.</summary>
<remarks>
<para>This method has the same effect as setting the <see cref="P:UIKit.NSLayoutConstraint.Active" /> property to <see langword="true" />.</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
var blueView = new ContentView(UIColor.Blue);
view.AddSubview(blueView);

Expand All @@ -73,24 +73,72 @@ var blueConstraints = new []
NSLayoutConstraint.ActivateConstraints(blueConstraints);

]]></code>
</example>
</example>
<para>
<img href="~/UIKit/_images/UIKit.NSLayoutAnchor.png" alt="Screenshot showing the resulting layout" />
</para>
</remarks>
</Docs>
<Docs DocId="M:UIKit.NSLayoutConstraint.FromVisualFormat(System.String,UIKit.NSLayoutFormatOptions,Foundation.NSDictionary,Foundation.NSDictionary)">
<param name="format">Visual format to use to create the constraints.</param>
<param name="formatOptions">options.</param>
<param name="metrics">
<para>Dictionary containing mapping names to numbers, where each name is associated with the given metric.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="views">Dictionary containing mappings of names to UIViews.</param>
<summary>Factory method for creating a constraint using Visual Format Language.</summary>
<returns>An array of layout constraints that are suitable to be added to a UIView using <see cref="M:UIKit.UIView.AddConstraints(UIKit.NSLayoutConstraint[])" /> method.</returns>
<remarks>
<para>It is easier to use the <see cref="M:UIKit.NSLayoutConstraint.FromVisualFormat(System.String,UIKit.NSLayoutFormatOptions,System.Object[])" /> overload as it combines support for both metrics and views in a single call.</para>
</remarks>
</Docs>
<Docs DocId="M:UIKit.NSLayoutConstraint.Create(Foundation.NSObject,UIKit.NSLayoutAttribute,UIKit.NSLayoutRelation,Foundation.NSObject,UIKit.NSLayoutAttribute,System.Runtime.InteropServices.NFloat,System.Runtime.InteropServices.NFloat)">
<param name="view1">First view in the constraint.</param>
<param name="attribute1">Attribute for the first view.</param>
<param name="relation">Relationships between the <paramref name="view1" /> and the <paramref name="view2" />.</param>
<param name="view2">
<para>Second view in the constraint.</para>
<para>This parameter can be <see langword="null" />.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="attribute2">Attribute for the second view.</param>
<param name="multiplier">Multiplier applied to the second attribute.</param>
<param name="constant">Constants to add.</param>
<summary>Factory method for creating a constraint.</summary>
<returns>
<para>New constraint with the specified parameters.</para>
<para>
<img href="~/UIKit/_images/UIKit.NSLayoutAnchor.png" alt="Screenshot showing the resulting layout" />
</para>
</returns>
<remarks>
<para>Creates a constraint relationship between the <paramref name="view1" /> and the <paramref name="view2" /> that satisfies the following linear equation:</para>
<para>
</para>
<para>
<paramref name="attribute1" /> = <paramref name="multiplier" /> x <paramref name="attribute2" /> + <paramref name="constant" /></para>
</remarks>
</Docs>
<Docs DocId="M:UIKit.NSLayoutConstraint.FromVisualFormat(System.String,UIKit.NSLayoutFormatOptions,Foundation.NSDictionary,Foundation.NSDictionary)">
<param name="format">Visual format to use to create the constraints.</param>
<param name="formatOptions">options.</param>
<param name="metrics">
<para>Dictionary containing mapping names to numbers, where each name is associated with the given metric.</para>
<Docs DocId="M:UIKit.NSLayoutConstraint.Create(ObjCRuntime.INativeObject,UIKit.NSLayoutAttribute,UIKit.NSLayoutRelation,ObjCRuntime.INativeObject,UIKit.NSLayoutAttribute,System.Runtime.InteropServices.NFloat,System.Runtime.InteropServices.NFloat)">
<param name="view1">First view in the constraint.</param>
<param name="attribute1">Attribute for the first view.</param>
<param name="relation">Relationships between the <paramref name="view1" /> and the <paramref name="view2" />.</param>
<param name="view2">
<para>Second view in the constraint.</para>
<para>This parameter can be <see langword="null" />.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<param name="views">Dictionary containing mappings of names to UIViews.</param>
<summary>Factory method for creating a constraint using Visual Format Language.</summary>
<returns>An array of layout constraints that are suitable to be added to a UIView using <see cref="M:UIKit.UIView.AddConstraints(UIKit.NSLayoutConstraint[])" /> method.</returns>
<param name="attribute2">Attribute for the second view.</param>
<param name="multiplier">Multiplier applied to the second attribute.</param>
<param name="constant">Constants to add.</param>
<summary>Factory method for creating a constraint.</summary>
<returns>New constraint with the specified parameters.</returns>
<remarks>
<para>It is easier to use the <see cref="M:UIKit.NSLayoutConstraint.FromVisualFormat(System.String,UIKit.NSLayoutFormatOptions,System.Object[])" /> overload as it combines support for both metrics and views in a single call.</para>
<para>Creates a constraint relationship between the <paramref name="view1" /> and the <paramref name="view2" /> that satisfies the following linear equation:</para>
<para>
</para>
<para>
<paramref name="attribute1" /> = <paramref name="multiplier" /> x <paramref name="attribute2" /> + <paramref name="constant" /></para>
</remarks>
</Docs>
</Documentation>
Loading