← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreText/CTFontCollection.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.CoreText/CTFontCollection.xml
22
22
    </Attribute>
23
23
  </Attributes>
24
24
  <Docs>
25
 
    <summary>To be added.</summary>
 
25
    <summary>Font collections are the standard mechanism used to enumerate fonts descriptors.</summary>
26
26
    <remarks>To be added.</remarks>
27
27
  </Docs>
28
28
  <Members>
37
37
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontCollectionOptions" />
38
38
      </Parameters>
39
39
      <Docs>
40
 
        <param name="options">To be added.</param>
41
 
        <summary>To be added.</summary>
42
 
        <remarks>To be added.</remarks>
 
40
        <param name="options">Configuration options for creating the font collection, can be null.</param>
 
41
        <summary>Creates a CTFontCollection that contains all of the available font descriptors.</summary>
 
42
        <remarks>
 
43
        </remarks>
43
44
      </Docs>
44
45
    </Member>
45
46
    <Member MemberName=".ctor">
54
55
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontCollectionOptions" />
55
56
      </Parameters>
56
57
      <Docs>
57
 
        <param name="queryDescriptors">To be added.</param>
 
58
        <param name="queryDescriptors">An array of font descriptors, can be null.</param>
58
59
        <param name="options">To be added.</param>
59
 
        <summary>To be added.</summary>
60
 
        <remarks>To be added.</remarks>
 
60
        <summary>Creates a CTFontCollection from the specified set of queryDescriptors.</summary>
 
61
        <remarks>
 
62
        </remarks>
61
63
      </Docs>
62
64
    </Member>
63
65
    <Member MemberName="Dispose">
72
74
      </ReturnValue>
73
75
      <Parameters />
74
76
      <Docs>
75
 
        <summary>Releases the resourced used by the CTFontCollection object.</summary>
 
77
        <summary>Releases the resources used by the CTFontCollection object.</summary>
76
78
        <remarks>
77
79
          <para>The Dispose method releases the resources used by the CTFontCollection class.</para>
78
80
          <para>Calling the Dispose method when you are finished using the CTFontCollection ensures that all external resources used by this managed object are released as soon as possible.  Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at http://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
96
98
        <param name="disposing">
97
99
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
98
100
        </param>
99
 
        <summary>Releases the resourced used by the CTFontCollection object.</summary>
 
101
        <summary>Releases the resources used by the CTFontCollection object.</summary>
100
102
        <remarks>
101
103
          <para>This Dispose method releases the resources used by the CTFontCollection class.</para>
102
104
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
134
136
      </ReturnValue>
135
137
      <Parameters />
136
138
      <Docs>
137
 
        <summary>To be added.</summary>
138
 
        <returns>To be added.</returns>
139
 
        <remarks>To be added.</remarks>
 
139
        <summary>Gets the mathching font descriptors from this collection.</summary>
 
140
        <returns>An array of font descriptors.</returns>
 
141
        <remarks>
 
142
        </remarks>
140
143
      </Docs>
141
144
    </Member>
142
145
    <Member MemberName="GetMatchingFontDescriptors">
153
156
        <Parameter Name="comparer" Type="System.Comparison&lt;MonoMac.CoreText.CTFontDescriptor&gt;" />
154
157
      </Parameters>
155
158
      <Docs>
156
 
        <param name="comparer">To be added.</param>
157
 
        <summary>To be added.</summary>
158
 
        <returns>To be added.</returns>
159
 
        <remarks>To be added.</remarks>
 
159
        <param name="comparer">Sorting method.</param>
 
160
        <summary>Gets an array of font descriptors sorted by the specified sorting function.</summary>
 
161
        <returns>An array of font descriptors.</returns>
 
162
        <remarks>
 
163
        </remarks>
160
164
      </Docs>
161
165
    </Member>
162
166
    <Member MemberName="Handle">
190
194
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontCollectionOptions" />
191
195
      </Parameters>
192
196
      <Docs>
193
 
        <param name="queryDescriptors">To be added.</param>
194
 
        <param name="options">To be added.</param>
195
 
        <summary>To be added.</summary>
196
 
        <returns>To be added.</returns>
197
 
        <remarks>To be added.</remarks>
 
197
        <param name="queryDescriptors">The font descriptors to add.</param>
 
198
        <param name="options">Configuration options for creating the font collection, can be null.</param>
 
199
        <summary>Creates a copy of the CTFontCollection while adding the specified font descriptors.</summary>
 
200
        <returns>
 
201
        </returns>
 
202
        <remarks>
 
203
        </remarks>
198
204
      </Docs>
199
205
    </Member>
200
206
  </Members>