Skip to content

Commit 175430f

Browse files
committed
delete code example text from obsolete types
1 parent a33f8fb commit 175430f

File tree

75 files changed

+1576
-4758
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1576
-4758
lines changed

xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,13 @@
2323
<Docs>
2424
<summary>Derivative of <see cref="T:System.Workflow.ComponentModel.Compiler.DependencyObjectValidator" /> that is a base class for all activity validator components.</summary>
2525
<remarks>
26-
<format type="text/markdown"><![CDATA[
27-
28-
## Remarks
29-
26+
<format type="text/markdown"><![CDATA[
27+
28+
## Remarks
29+
3030
> [!NOTE]
31-
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
32-
33-
34-
35-
## Examples
36-
The following example shows a complete <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator> used for a custom activity. The custom activity is a `ConsoleWriteLineActivity` activity that has a single dependency property named `Msg` of type <xref:System.String>. The validator ensures that the `Msg` property is set. If it is not set, the compiler displays an error when the <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator.Validate%2A> method is called on the <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator> and the compilation fails.
37-
38-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs" id="Snippet1":::
39-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb" id="Snippet1":::
40-
31+
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
32+
4133
]]></format>
4234
</remarks>
4335
</Docs>
@@ -86,21 +78,13 @@
8678
<summary>Verifies that the given activity is valid.</summary>
8779
<returns>A <see cref="T:System.Workflow.ComponentModel.Compiler.ValidationErrorCollection" /> object that contains any errors or warnings that occurred during validation.</returns>
8880
<remarks>
89-
<format type="text/markdown"><![CDATA[
90-
91-
## Remarks
92-
This method calls <xref:System.Workflow.ComponentModel.Compiler.Validator.ValidateProperties%2A> to validate the properties of the <xref:System.Workflow.ComponentModel.Activity>.
93-
94-
This method only validates the uniqueness of the <xref:System.Workflow.ComponentModel.Activity.Name%2A> for the <xref:System.Workflow.ComponentModel.Activity> if the <xref:System.Workflow.ComponentModel.Activity> is not a root <xref:System.Workflow.ComponentModel.Activity>.
95-
96-
97-
98-
## Examples
99-
The following example shows how to override the <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator.Validate%2A> method for an <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator> used for a custom activity that has a single dependency property named `Msg` of type <xref:System.String>. The custom validator ensures that the `Msg` property is set. If it is not set, the compiler displays an error when the <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator.Validate%2A> method is called on the <xref:System.Workflow.ComponentModel.Compiler.ActivityValidator> and the compilation fails.
100-
101-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_activities_project/cs/consolewritelineactivity.cs" id="Snippet3":::
102-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_activities_project/vb/consolewritelineactivity.vb" id="Snippet3":::
103-
81+
<format type="text/markdown"><![CDATA[
82+
83+
## Remarks
84+
This method calls <xref:System.Workflow.ComponentModel.Compiler.Validator.ValidateProperties%2A> to validate the properties of the <xref:System.Workflow.ComponentModel.Activity>.
85+
86+
This method only validates the uniqueness of the <xref:System.Workflow.ComponentModel.Activity.Name%2A> for the <xref:System.Workflow.ComponentModel.Activity> if the <xref:System.Workflow.ComponentModel.Activity> is not a root <xref:System.Workflow.ComponentModel.Activity>.
87+
10488
]]></format>
10589
</remarks>
10690
</Docs>

xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,7 @@
8282
<Docs>
8383
<summary>Gets the programming language used by the environment, such as Visual Studio, when compiling the workflow.</summary>
8484
<value>The name of the programming language used by the development environment.</value>
85-
<remarks>
86-
<format type="text/markdown"><![CDATA[
87-
88-
## Examples
89-
The following example shows an implementation of the `Language` property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)).
90-
91-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet123":::
92-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet123":::
93-
94-
]]></format>
95-
</remarks>
85+
<remarks>To be added.</remarks>
9686
</Docs>
9787
</Member>
9888
<Member MemberName="RootNamespace">
@@ -120,14 +110,6 @@
120110
## Remarks
121111
This property is used in Visual Basic compilation environment to pass the root namespace of the project to the compiler.
122112
123-
124-
125-
## Examples
126-
The following example shows an implementation of the `RootNamespace` property. This example is from the Tracking Profile Designer SDK sample. For more information, see [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)).
127-
128-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet122":::
129-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet122":::
130-
131113
]]></format>
132114
</remarks>
133115
</Docs>

xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml

Lines changed: 57 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,18 @@
3333
<Docs>
3434
<summary>An implementation of <see cref="T:System.Workflow.ComponentModel.Compiler.ITypeProvider" /> that acts as a container of types within the indicated assemblies and code compile units.</summary>
3535
<remarks>
36-
<format type="text/markdown"><![CDATA[
37-
38-
## Remarks
39-
36+
<format type="text/markdown"><![CDATA[
37+
38+
## Remarks
39+
4040
> [!NOTE]
41-
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
42-
43-
This <xref:System.Workflow.ComponentModel.Compiler.ITypeProvider> implementation, in addition to handling compiled assemblies (<xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly%2A> and <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssemblyReference%2A> methods), can handle types that have not been compiled yet (<xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddCodeCompileUnit%2A>). The limited implementation of <xref:System.Type?displayProperty=nameWithType> is returned for types referenced using <xref:System.CodeDom.CodeCompileUnit>.
44-
41+
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
42+
43+
This <xref:System.Workflow.ComponentModel.Compiler.ITypeProvider> implementation, in addition to handling compiled assemblies (<xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly%2A> and <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssemblyReference%2A> methods), can handle types that have not been compiled yet (<xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddCodeCompileUnit%2A>). The limited implementation of <xref:System.Type?displayProperty=nameWithType> is returned for types referenced using <xref:System.CodeDom.CodeCompileUnit>.
44+
4545
> [!NOTE]
46-
> <xref:System.Workflow.ComponentModel.Compiler.TypeProvider> only returns public types from referenced assemblies, and both public and non-public types from local assemblies.
47-
46+
> <xref:System.Workflow.ComponentModel.Compiler.TypeProvider> only returns public types from referenced assemblies, and both public and non-public types from local assemblies.
47+
4848
]]></format>
4949
</remarks>
5050
</Docs>
@@ -68,17 +68,7 @@
6868
<Docs>
6969
<param name="serviceProvider">The encapsulated <see cref="T:System.IServiceProvider" /> for this instance.</param>
7070
<summary>Initializes a new instance of the <see cref="T:System.Workflow.ComponentModel.Compiler.TypeProvider" /> class.</summary>
71-
<remarks>
72-
<format type="text/markdown"><![CDATA[
73-
74-
## Examples
75-
The following code example shows how to create a new instance of the <xref:System.Workflow.ComponentModel.Compiler.TypeProvider> class. This code example is part of the BasicDesignerHosting SDK Sample from the WorkflowLoader.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)).
76-
77-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet256":::
78-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet256":::
79-
80-
]]></format>
81-
</remarks>
71+
<remarks>To be added.</remarks>
8272
</Docs>
8373
</Member>
8474
<Member MemberName="AddAssembly">
@@ -130,17 +120,7 @@
130120
<Docs>
131121
<param name="path">The path of the <see cref="P:System.Type.Assembly" /> to add.</param>
132122
<summary>Adds a reference to the <see cref="P:System.Type.Assembly" /> to the internal list. This assembly is used for the <see cref="T:System.Type" /> lookup in the <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.GetType(System.String)" /> method.</summary>
133-
<remarks>
134-
<format type="text/markdown"><![CDATA[
135-
136-
## Examples
137-
The following code example shows how to create a new instance of the <xref:System.Workflow.ComponentModel.Compiler.TypeProvider> class and run the <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssemblyReference%2A> method. This code example is part of the BasicDesignerHosting SDK Sample from the WorkflowLoader.cs file. For more information, see [Basic Designer Hosting](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741708(v=vs.90)).
138-
139-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets24.cs" id="Snippet256":::
140-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets24.vb" id="Snippet256":::
141-
142-
]]></format>
143-
</remarks>
123+
<remarks>To be added.</remarks>
144124
<exception cref="T:System.ArgumentNullException">
145125
<paramref name="path" /> is a null reference (Visual Basic <see langword="Nothing" />).</exception>
146126
</Docs>
@@ -330,11 +310,11 @@
330310
<summary>Gets the <see cref="T:System.Object" /> that provides the designated service <see cref="T:System.Type" />.</summary>
331311
<returns>The <see cref="T:System.Object" /> that provides the designated service <see cref="T:System.Type" />.</returns>
332312
<remarks>
333-
<format type="text/markdown"><![CDATA[
334-
335-
## Remarks
336-
If the encapsulated <xref:System.IServiceProvider> associated with this instance is a null reference (`Nothing` in Visual Basic) then a null reference (`Nothing`) is returned.
337-
313+
<format type="text/markdown"><![CDATA[
314+
315+
## Remarks
316+
If the encapsulated <xref:System.IServiceProvider> associated with this instance is a null reference (`Nothing` in Visual Basic) then a null reference (`Nothing`) is returned.
317+
338318
]]></format>
339319
</remarks>
340320
</Docs>
@@ -375,11 +355,11 @@
375355
<summary>Gets the type from the set of assemblies added to the <see langword="TypeProvider" /> using <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly(System.Reflection.Assembly)" />, <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssemblyReference(System.String)" />, or <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddCodeCompileUnit(System.CodeDom.CodeCompileUnit)" />.</summary>
376356
<returns>The requested <see cref="T:System.Type" />.</returns>
377357
<remarks>
378-
<format type="text/markdown"><![CDATA[
379-
380-
## Remarks
381-
If the name is not resolvable within the cache of assemblies and compiled units of this instance, a null reference (Visual Basic `Nothing`) is returned. Invoking this overload is the same as invoking the two parameter overloads with the value of the parameter `throwOnError` set to `true`.
382-
358+
<format type="text/markdown"><![CDATA[
359+
360+
## Remarks
361+
If the name is not resolvable within the cache of assemblies and compiled units of this instance, a null reference (Visual Basic `Nothing`) is returned. Invoking this overload is the same as invoking the two parameter overloads with the value of the parameter `throwOnError` set to `true`.
362+
383363
]]></format>
384364
</remarks>
385365
<exception cref="T:System.ArgumentNullException">
@@ -415,11 +395,11 @@
415395
<summary>Gets the type from the set of assemblies added to the <see langword="TypeProvider" /> using <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly(System.Reflection.Assembly)" />, <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssemblyReference(System.String)" />, or <see cref="M:System.Workflow.ComponentModel.Compiler.TypeProvider.AddCodeCompileUnit(System.CodeDom.CodeCompileUnit)" />.</summary>
416396
<returns>The requested <see cref="T:System.Type" />.</returns>
417397
<remarks>
418-
<format type="text/markdown"><![CDATA[
419-
420-
## Remarks
421-
If the name is not resolvable within the cache of assemblies and compiled units of this instance, a null reference (`Nothing`) is returned; in the case that `throwOnError` is `false`.
422-
398+
<format type="text/markdown"><![CDATA[
399+
400+
## Remarks
401+
If the name is not resolvable within the cache of assemblies and compiled units of this instance, a null reference (`Nothing`) is returned; in the case that `throwOnError` is `false`.
402+
423403
]]></format>
424404
</remarks>
425405
<exception cref="T:System.ArgumentNullException">
@@ -666,11 +646,11 @@
666646
<param name="refresher">The <see cref="T:System.EventHandler" /> to delegate this event to.</param>
667647
<summary>Updates the <see cref="T:System.CodeDom.CodeCompileUnit" /> reference associated with this instance.</summary>
668648
<remarks>
669-
<format type="text/markdown"><![CDATA[
670-
671-
## Remarks
672-
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
673-
649+
<format type="text/markdown"><![CDATA[
650+
651+
## Remarks
652+
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
653+
674654
]]></format>
675655
</remarks>
676656
<exception cref="T:System.ArgumentNullException">
@@ -701,11 +681,11 @@
701681
<param name="assembly">The <see cref="T:System.Reflection.Assembly" /> to remove from this instance.</param>
702682
<summary>Removes all references to the subject <see cref="T:System.Reflection.Assembly" /> from this instance.</summary>
703683
<remarks>
704-
<format type="text/markdown"><![CDATA[
705-
706-
## Remarks
707-
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
708-
684+
<format type="text/markdown"><![CDATA[
685+
686+
## Remarks
687+
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
688+
709689
]]></format>
710690
</remarks>
711691
<exception cref="T:System.ArgumentNullException">
@@ -735,11 +715,11 @@
735715
<param name="path">The path of the <see cref="T:System.Reflection.Assembly" /> to be removed.</param>
736716
<summary>Removes a path-based <see cref="T:System.Reflection.Assembly" /> reference from this instance.</summary>
737717
<remarks>
738-
<format type="text/markdown"><![CDATA[
739-
740-
## Remarks
741-
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
742-
718+
<format type="text/markdown"><![CDATA[
719+
720+
## Remarks
721+
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
722+
743723
]]></format>
744724
</remarks>
745725
<exception cref="T:System.ArgumentNullException">
@@ -769,11 +749,11 @@
769749
<param name="codeCompileUnit">The <see cref="T:System.CodeDom.CodeCompileUnit" /> to be removed.</param>
770750
<summary>Removes all references to the subject <see cref="T:System.CodeDom.CodeCompileUnit" /> from this instance.</summary>
771751
<remarks>
772-
<format type="text/markdown"><![CDATA[
773-
774-
## Remarks
775-
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
776-
752+
<format type="text/markdown"><![CDATA[
753+
754+
## Remarks
755+
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked.
756+
777757
]]></format>
778758
</remarks>
779759
<exception cref="T:System.ArgumentNullException">
@@ -803,11 +783,11 @@
803783
<param name="assembly">The <see cref="T:System.Reflection.Assembly" /> used to set this value.</param>
804784
<summary>Sets the value of the local <see cref="T:System.Reflection.Assembly" /> to the referenced <see cref="T:System.Reflection.Assembly" /> .</summary>
805785
<remarks>
806-
<format type="text/markdown"><![CDATA[
807-
808-
## Remarks
809-
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked. Call <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.SetLocalAssembly%28System.Reflection.Assembly%29> before you call <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly%28System.Reflection.Assembly%29> otherwise it has no affect on the <xref:System.Workflow.ComponentModel.Compiler.TypeProvider>.
810-
786+
<format type="text/markdown"><![CDATA[
787+
788+
## Remarks
789+
The <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.TypesChanged> is raised when this method is invoked. Call <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.SetLocalAssembly%28System.Reflection.Assembly%29> before you call <xref:System.Workflow.ComponentModel.Compiler.TypeProvider.AddAssembly%28System.Reflection.Assembly%29> otherwise it has no affect on the <xref:System.Workflow.ComponentModel.Compiler.TypeProvider>.
790+
811791
]]></format>
812792
</remarks>
813793
</Docs>
@@ -835,11 +815,11 @@
835815
<summary>Gets an <see cref="T:System.Collections.IDictionary" /> of load error exceptions keyed by the <see cref="T:System.Object" /> that causes the <see cref="T:System.Exception" />.</summary>
836816
<value>An <see cref="T:System.Collections.IDictionary" /> of load error exceptions keyed by the <see cref="T:System.Object" /> that causes the <see cref="T:System.Exception" />.</value>
837817
<remarks>
838-
<format type="text/markdown"><![CDATA[
839-
840-
## Remarks
841-
An updated, detached <xref:System.Collections.IDictionary> is created at each reference to this property.
842-
818+
<format type="text/markdown"><![CDATA[
819+
820+
## Remarks
821+
An updated, detached <xref:System.Collections.IDictionary> is created at each reference to this property.
822+
843823
]]></format>
844824
</remarks>
845825
</Docs>

0 commit comments

Comments
 (0)