← Back to branch summary

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

« back to all changes in this revision

Viewing changes to external/mono-addins/docs/Mono.Addins/Addin.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/mono-addins/docs/Mono.Addins/Addin.xml
 
1
<Type Name="Addin" FullName="Mono.Addins.Addin">
 
2
  <TypeSignature Language="C#" Value="public class Addin" />
 
3
  <AssemblyInfo>
 
4
    <AssemblyName>Mono.Addins</AssemblyName>
 
5
    <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
6
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>System.Object</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Docs>
 
13
    <summary>An add-in.</summary>
 
14
    <remarks>Represents an add-in installed in a registry.</remarks>
 
15
  </Docs>
 
16
  <Members>
 
17
    <Member MemberName="AddinFile">
 
18
      <MemberSignature Language="C#" Value="public string AddinFile { get; }" />
 
19
      <MemberType>Property</MemberType>
 
20
      <ReturnValue>
 
21
        <ReturnType>System.String</ReturnType>
 
22
      </ReturnValue>
 
23
      <Docs>
 
24
        <summary>Location of the add-in.</summary>
 
25
        <value>Full path to the add-in.</value>
 
26
        <remarks>Returns the location of the add-in. It can be an assembly or a .addin file (when distributed standalone).</remarks>
 
27
      </Docs>
 
28
      <AssemblyInfo>
 
29
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
30
      </AssemblyInfo>
 
31
    </Member>
 
32
    <Member MemberName="CompareVersions">
 
33
      <MemberSignature Language="C#" Value="public static int CompareVersions (string v1, string v2);" />
 
34
      <MemberType>Method</MemberType>
 
35
      <ReturnValue>
 
36
        <ReturnType>System.Int32</ReturnType>
 
37
      </ReturnValue>
 
38
      <Parameters>
 
39
        <Parameter Name="v1" Type="System.String" />
 
40
        <Parameter Name="v2" Type="System.String" />
 
41
      </Parameters>
 
42
      <Docs>
 
43
        <param name="v1">To be added.</param>
 
44
        <param name="v2">To be added.</param>
 
45
        <summary>Compares two add-in versions.</summary>
 
46
        <returns>To be added.</returns>
 
47
        <remarks>To be added.</remarks>
 
48
      </Docs>
 
49
      <AssemblyInfo>
 
50
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
51
      </AssemblyInfo>
 
52
    </Member>
 
53
    <Member MemberName="Description">
 
54
      <MemberSignature Language="C#" Value="public Mono.Addins.Description.AddinDescription Description { get; }" />
 
55
      <MemberType>Property</MemberType>
 
56
      <ReturnValue>
 
57
        <ReturnType>Mono.Addins.Description.AddinDescription</ReturnType>
 
58
      </ReturnValue>
 
59
      <Docs>
 
60
        <summary>Description of the add-in.</summary>
 
61
        <value>The description of the add-in.</value>
 
62
        <remarks />
 
63
      </Docs>
 
64
      <AssemblyInfo>
 
65
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
66
      </AssemblyInfo>
 
67
    </Member>
 
68
    <Member MemberName="Enabled">
 
69
      <MemberSignature Language="C#" Value="public bool Enabled { set; get; }" />
 
70
      <MemberType>Property</MemberType>
 
71
      <ReturnValue>
 
72
        <ReturnType>System.Boolean</ReturnType>
 
73
      </ReturnValue>
 
74
      <Docs>
 
75
        <summary>Gets or sets the enabled status of the add-in.</summary>
 
76
        <value>'true' if enabled.</value>
 
77
        <remarks>
 
78
          <para>This property can be used to enable or disable an add-in. The enabled status of an add-in is stored in the add-in registry, so when an add-in is disabled, it will be disabled for all applications sharing the same registry.</para>
 
79
          <para>
 
80
When an add-in is enabled or disabled, the extension points currently loaded in memory will be properly updated to include or exclude extensions from the add-in.
 
81
</para>
 
82
        </remarks>
 
83
      </Docs>
 
84
      <AssemblyInfo>
 
85
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
86
      </AssemblyInfo>
 
87
    </Member>
 
88
    <Member MemberName="GetFullId">
 
89
      <MemberSignature Language="C#" Value="public static string GetFullId (string ns, string id, string version);" />
 
90
      <MemberType>Method</MemberType>
 
91
      <ReturnValue>
 
92
        <ReturnType>System.String</ReturnType>
 
93
      </ReturnValue>
 
94
      <Parameters>
 
95
        <Parameter Name="ns" Type="System.String" />
 
96
        <Parameter Name="id" Type="System.String" />
 
97
        <Parameter Name="version" Type="System.String" />
 
98
      </Parameters>
 
99
      <Docs>
 
100
        <param name="ns">To be added.</param>
 
101
        <param name="id">To be added.</param>
 
102
        <param name="version">To be added.</param>
 
103
        <summary>Returns the full id of an add-in.</summary>
 
104
        <returns>To be added.</returns>
 
105
        <remarks>To be added.</remarks>
 
106
      </Docs>
 
107
      <AssemblyInfo>
 
108
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
109
      </AssemblyInfo>
 
110
    </Member>
 
111
    <Member MemberName="GetIdName">
 
112
      <MemberSignature Language="C#" Value="public static string GetIdName (string addinId);" />
 
113
      <MemberType>Method</MemberType>
 
114
      <ReturnValue>
 
115
        <ReturnType>System.String</ReturnType>
 
116
      </ReturnValue>
 
117
      <Parameters>
 
118
        <Parameter Name="addinId" Type="System.String" />
 
119
      </Parameters>
 
120
      <Docs>
 
121
        <param name="addinId">To be added.</param>
 
122
        <summary>Returns the namespace and id from a full add-in id.</summary>
 
123
        <returns>To be added.</returns>
 
124
        <remarks>To be added.</remarks>
 
125
      </Docs>
 
126
      <AssemblyInfo>
 
127
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
128
      </AssemblyInfo>
 
129
    </Member>
 
130
    <Member MemberName="GetIdParts">
 
131
      <MemberSignature Language="C#" Value="public static void GetIdParts (string addinId, out string name, out string version);" />
 
132
      <MemberType>Method</MemberType>
 
133
      <ReturnValue>
 
134
        <ReturnType>System.Void</ReturnType>
 
135
      </ReturnValue>
 
136
      <Parameters>
 
137
        <Parameter Name="addinId" Type="System.String" />
 
138
        <Parameter Name="name" Type="System.String&amp;" RefType="out" />
 
139
        <Parameter Name="version" Type="System.String&amp;" RefType="out" />
 
140
      </Parameters>
 
141
      <Docs>
 
142
        <param name="addinId">To be added.</param>
 
143
        <param name="name">To be added.</param>
 
144
        <param name="version">To be added.</param>
 
145
        <summary>To be added.</summary>
 
146
        <remarks>To be added.</remarks>
 
147
      </Docs>
 
148
      <AssemblyInfo>
 
149
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
150
      </AssemblyInfo>
 
151
    </Member>
 
152
    <Member MemberName="GetIdVersion">
 
153
      <MemberSignature Language="C#" Value="public static string GetIdVersion (string addinId);" />
 
154
      <MemberType>Method</MemberType>
 
155
      <ReturnValue>
 
156
        <ReturnType>System.String</ReturnType>
 
157
      </ReturnValue>
 
158
      <Parameters>
 
159
        <Parameter Name="addinId" Type="System.String" />
 
160
      </Parameters>
 
161
      <Docs>
 
162
        <param name="addinId">To be added.</param>
 
163
        <summary>To be added.</summary>
 
164
        <returns>To be added.</returns>
 
165
        <remarks>To be added.</remarks>
 
166
      </Docs>
 
167
      <AssemblyInfo>
 
168
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
169
      </AssemblyInfo>
 
170
    </Member>
 
171
    <Member MemberName="Id">
 
172
      <MemberSignature Language="C#" Value="public string Id { get; }" />
 
173
      <MemberType>Property</MemberType>
 
174
      <ReturnValue>
 
175
        <ReturnType>System.String</ReturnType>
 
176
      </ReturnValue>
 
177
      <Docs>
 
178
        <summary>Identifier of the add-in.</summary>
 
179
        <value>Identifier of the add-in.</value>
 
180
        <remarks>Full identifier of the add-in, including namespace and version.</remarks>
 
181
      </Docs>
 
182
      <AssemblyInfo>
 
183
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
184
      </AssemblyInfo>
 
185
    </Member>
 
186
    <Member MemberName="IsUserAddin">
 
187
      <MemberSignature Language="C#" Value="public bool IsUserAddin { get; }" />
 
188
      <MemberType>Property</MemberType>
 
189
      <AssemblyInfo>
 
190
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
191
      </AssemblyInfo>
 
192
      <ReturnValue>
 
193
        <ReturnType>System.Boolean</ReturnType>
 
194
      </ReturnValue>
 
195
      <Docs>
 
196
        <summary>To be added.</summary>
 
197
        <value>To be added.</value>
 
198
        <remarks>To be added.</remarks>
 
199
      </Docs>
 
200
    </Member>
 
201
    <Member MemberName="LocalId">
 
202
      <MemberSignature Language="C#" Value="public string LocalId { get; }" />
 
203
      <MemberType>Property</MemberType>
 
204
      <ReturnValue>
 
205
        <ReturnType>System.String</ReturnType>
 
206
      </ReturnValue>
 
207
      <Docs>
 
208
        <summary>Local identifier of the add-in.</summary>
 
209
        <value>The ID.</value>
 
210
        <remarks>Does not include the namespace.</remarks>
 
211
      </Docs>
 
212
      <AssemblyInfo>
 
213
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
214
      </AssemblyInfo>
 
215
    </Member>
 
216
    <Member MemberName="Name">
 
217
      <MemberSignature Language="C#" Value="public string Name { get; }" />
 
218
      <MemberType>Property</MemberType>
 
219
      <ReturnValue>
 
220
        <ReturnType>System.String</ReturnType>
 
221
      </ReturnValue>
 
222
      <Docs>
 
223
        <summary>Display name of the add-in.</summary>
 
224
        <value>The name.</value>
 
225
        <remarks>Name to be shown in the add-in management tools.</remarks>
 
226
      </Docs>
 
227
      <AssemblyInfo>
 
228
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
229
      </AssemblyInfo>
 
230
    </Member>
 
231
    <Member MemberName="Namespace">
 
232
      <MemberSignature Language="C#" Value="public string Namespace { get; }" />
 
233
      <MemberType>Property</MemberType>
 
234
      <ReturnValue>
 
235
        <ReturnType>System.String</ReturnType>
 
236
      </ReturnValue>
 
237
      <Docs>
 
238
        <summary>Namespace of the add-in.</summary>
 
239
        <value>Namespace of the add-in.</value>
 
240
        <remarks />
 
241
      </Docs>
 
242
      <AssemblyInfo>
 
243
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
244
      </AssemblyInfo>
 
245
    </Member>
 
246
    <Member MemberName="SupportsVersion">
 
247
      <MemberSignature Language="C#" Value="public bool SupportsVersion (string version);" />
 
248
      <MemberType>Method</MemberType>
 
249
      <ReturnValue>
 
250
        <ReturnType>System.Boolean</ReturnType>
 
251
      </ReturnValue>
 
252
      <Parameters>
 
253
        <Parameter Name="version" Type="System.String" />
 
254
      </Parameters>
 
255
      <Docs>
 
256
        <param name="version">An add-in version.</param>
 
257
        <summary>Checks version compatibility.</summary>
 
258
        <returns>True if the provided version is compatible with this add-in.</returns>
 
259
        <remarks>This method checks the CompatVersion property to know if the provided version is compatible with the version of this add-in.</remarks>
 
260
      </Docs>
 
261
      <AssemblyInfo>
 
262
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
263
      </AssemblyInfo>
 
264
    </Member>
 
265
    <Member MemberName="ToString">
 
266
      <MemberSignature Language="C#" Value="public override string ToString ();" />
 
267
      <MemberType>Method</MemberType>
 
268
      <AssemblyInfo>
 
269
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
270
      </AssemblyInfo>
 
271
      <ReturnValue>
 
272
        <ReturnType>System.String</ReturnType>
 
273
      </ReturnValue>
 
274
      <Parameters />
 
275
      <Docs>
 
276
        <summary>To be added.</summary>
 
277
        <returns>To be added.</returns>
 
278
        <remarks>To be added.</remarks>
 
279
      </Docs>
 
280
    </Member>
 
281
    <Member MemberName="Version">
 
282
      <MemberSignature Language="C#" Value="public string Version { get; }" />
 
283
      <MemberType>Property</MemberType>
 
284
      <ReturnValue>
 
285
        <ReturnType>System.String</ReturnType>
 
286
      </ReturnValue>
 
287
      <Docs>
 
288
        <summary>Version of the add-in.</summary>
 
289
        <value>The version.</value>
 
290
        <remarks />
 
291
      </Docs>
 
292
      <AssemblyInfo>
 
293
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
294
      </AssemblyInfo>
 
295
    </Member>
 
296
  </Members>
 
297
</Type>