Skip to content

Commit 792ea6b

Browse files
authored
Add missing text - System.Web (dotnet#8112)
1 parent 242605d commit 792ea6b

File tree

52 files changed

+115
-175
lines changed

Some content is hidden

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

52 files changed

+115
-175
lines changed

xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@
3737
## Remarks
3838
You use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> class to retrieve information about a profile property when you access profiles through the <xref:System.Web.ApplicationServices.ProfileService> class. You can retrieve the name and type of the property, whether it is read-only, whether it can be accessed by users who have not been authenticated, and the default value. An application can take the appropriate actions based on these values, such as not trying to set a read-only property.
3939
40-
To access the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object from an application that is compatible with the Windows Communication Framework (WCF), use the <xref:System.Web.ApplicationServices.ProfileService.GetPropertiesMetadata%2A> method of the <xref:System.Web.ApplicationServices.ProfileService> class. The user does not have to be logged on to retrieve the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object because the metadata for profile properties is not specific to a user's profile property values.
41-
42-
The values in the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> class are set in the Web.config file in the element of the section when the property is defined.
40+
To access the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object from an application that's compatible with Windows Communication Framework (WCF), use the <xref:System.Web.ApplicationServices.ProfileService.GetPropertiesMetadata%2A> method of the <xref:System.Web.ApplicationServices.ProfileService> class. The user does not have to be logged on to retrieve the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object because the metadata for profile properties is not specific to a user's profile property values.
4341
4442
]]></format>
4543
</remarks>
@@ -107,7 +105,7 @@
107105
<format type="text/markdown"><![CDATA[
108106
109107
## Remarks
110-
When you enable anonymous identification with settings in the element, you can set which profile properties are available to anonymous users. You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property in the element of the section of the Web.config file when the property is defined. From the client application, use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property to determine whether a profile property can be set for an anonymous user.
108+
When you enable anonymous identification, you can set which profile properties are available to anonymous users. From the client application, use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property to determine whether a profile property can be set for an anonymous user.
111109
112110
]]></format>
113111
</remarks>
@@ -225,14 +223,7 @@
225223
<summary>Gets or sets a value that indicates whether a profile property is read-only.</summary>
226224
<value>
227225
<see langword="true" /> if the profile property is read-only; otherwise, <see langword="false" />.</value>
228-
<remarks>
229-
<format type="text/markdown"><![CDATA[
230-
231-
## Remarks
232-
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.IsReadOnly%2A> property in the element of the section of the Web.config file when the property is defined.
233-
234-
]]></format>
235-
</remarks>
226+
<remarks>To be added.</remarks>
236227
</Docs>
237228
</Member>
238229
<Member MemberName="PropertyName">
@@ -268,14 +259,7 @@
268259
<Docs>
269260
<summary>Gets or sets the name of the profile property.</summary>
270261
<value>The name of the profile property as defined in the Web.config file.</value>
271-
<remarks>
272-
<format type="text/markdown"><![CDATA[
273-
274-
## Remarks
275-
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.PropertyName%2A> property in the element of the section of the Web.config file when the property is defined.
276-
277-
]]></format>
278-
</remarks>
262+
<remarks>To be added.</remarks>
279263
</Docs>
280264
</Member>
281265
<Member MemberName="SerializeAs">
@@ -311,14 +295,7 @@
311295
<Docs>
312296
<summary>Gets or sets a value that indicates how to serialize the property value.</summary>
313297
<value>The enumeration value.</value>
314-
<remarks>
315-
<format type="text/markdown"><![CDATA[
316-
317-
## Remarks
318-
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.SerializeAs%2A> property in the element of the section of the Web.config file when the property is defined.
319-
320-
]]></format>
321-
</remarks>
298+
<remarks>To be added.</remarks>
322299
</Docs>
323300
</Member>
324301
<Member MemberName="TypeName">
@@ -354,14 +331,7 @@
354331
<Docs>
355332
<summary>Gets or sets the assembly-qualified name of the profile property type.</summary>
356333
<value>The assembly-qualified name of the profile property type.</value>
357-
<remarks>
358-
<format type="text/markdown"><![CDATA[
359-
360-
## Remarks
361-
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.TypeName%2A> property in the element of the section of the Web.config file when the property is defined.
362-
363-
]]></format>
364-
</remarks>
334+
<remarks>To be added.</remarks>
365335
</Docs>
366336
</Member>
367337
</Members>

xml/System.Web.Caching/OutputCacheUtility.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<Parameter Name="cacheKey" Type="System.String" Index="0" FrameworkAlternate="netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
6363
</Parameters>
6464
<Docs>
65-
<param name="cacheKey">A string that contains the URI to flush.</param>
65+
<param name="cacheKey">A string that contains the URI to flush.</param>
6666
<summary>Flushes the kernel cache for a specific Uniform Resource Identifier (URI).</summary>
6767
<remarks>To be added.</remarks>
6868
</Docs>

xml/System.Web.Caching/SqlCacheDependency.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
2525
The <xref:System.Web.Caching.SqlCacheDependency> class also supports integration with the <xref:System.Data.SqlClient.SqlDependency?displayProperty=nameWithType> class when using a SQL Server 2005 database. The query notification mechanism of SQL Server 2005 detects changes to data that invalidate the results of an SQL query and removes any cached items associated with the SQL query from the <xref:System.Web.Caching.Cache?displayProperty=nameWithType>.
2626
27-
You can use the <xref:System.Web.Caching.SqlCacheDependency> class to add items to your application's <xref:System.Web.Caching.Cache> that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the <xref:System.Web.Caching.SqlCacheDependency> class with the page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the directive for user controls.
27+
You can use the <xref:System.Web.Caching.SqlCacheDependency> class to add items to your application's <xref:System.Web.Caching.Cache> that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the `@ OutputCache` directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the <xref:System.Web.Caching.SqlCacheDependency> class with the `@ OutputCache` page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the `@ OutputCache` directive for user controls.
2828
2929
> [!NOTE]
30-
> For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the <xref:System.Web.Caching.SqlCacheDependencyAdmin> class or by using the command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file.
30+
> For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the <xref:System.Web.Caching.SqlCacheDependencyAdmin> class or by using the `aspnet_regsql.exe` command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file.
3131
>
32-
> Using a <xref:System.Web.Caching.SqlCacheDependency> object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server 2005 Books Online for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification.
32+
> Using a <xref:System.Web.Caching.SqlCacheDependency> object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server documentation for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification.
3333
3434
The following example shows an ASP.NET Web.config file that enables table-based dependencies on a SQL Server database table.
3535
@@ -114,7 +114,7 @@
114114
]]></format>
115115
</remarks>
116116
<exception cref="T:System.ArgumentNullException">The <paramref name="sqlCmd" /> parameter is <see langword="null" />.</exception>
117-
<exception cref="T:System.Web.HttpException">The <see cref="T:System.Data.SqlClient.SqlCommand" /> instance has its <see cref="P:System.Data.SqlClient.SqlCommand.NotificationAutoEnlist" /> property set to <see langword="true" /> and there is an directive on the page with the <see langword="SqlDependency" /> attribute set to <c>CommandNotification</c>.</exception>
117+
<exception cref="T:System.Web.HttpException">The <see cref="T:System.Data.SqlClient.SqlCommand" /> instance has its <see cref="P:System.Data.SqlClient.SqlCommand.NotificationAutoEnlist" /> property set to <see langword="true" /> and there is an `@ OutputCache` directive on the page with the <see langword="SqlDependency" /> attribute set to <c>CommandNotification</c>.</exception>
118118
<altmember cref="M:System.Web.Caching.SqlCacheDependency.#ctor(System.String,System.String)" />
119119
</Docs>
120120
</Member>
@@ -167,7 +167,7 @@
167167
</configuration>
168168
```
169169
170-
Two exceptions are commonly thrown when this constructor is used: <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> and <xref:System.Web.Caching.TableNotEnabledForNotificationException>. If a <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableNotifications%2A?displayProperty=nameWithType> method in exception-handling code, or use the command-line tool to set up the database for notifications. If a <xref:System.Web.Caching.TableNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableTableForNotifications%2A?displayProperty=nameWithType> method or use to set up the table for notifications.
170+
Two exceptions are commonly thrown when this constructor is used: <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> and <xref:System.Web.Caching.TableNotEnabledForNotificationException>. If a <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableNotifications%2A?displayProperty=nameWithType> method in exception-handling code, or use the `aspnet_regsql.exe` command-line tool to set up the database for notifications. If a <xref:System.Web.Caching.TableNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableTableForNotifications%2A?displayProperty=nameWithType> method or use `aspnet_regsql.exe` to set up the table for notifications.
171171
172172
173173

xml/System.Web.Compilation/BuildProvider.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
3131
To define custom build actions for a file type within an ASP.NET application, you must derive a class from <xref:System.Web.Compilation.BuildProvider>, implement members within the derived class for building the file type, and configure the build provider for the corresponding file extension within the application configuration file.
3232
33-
The specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the <xref:System.Web.Compilation.BuildProviderAppliesToAttribute> class to specify whether the build provider applies to files in the App_Code directory, to files in a Web content directory, to global or local resources, or to all files. Use the `extension` attribute to specify the file extension used to identify files that the <xref:System.Web.Compilation.BuildProvider> class supports. Use the <xref:System.Web.Configuration.BuildProviderCollection> class to examine build providers in a configuration file. For more information about configuring a build provider, see [buildProviders Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/40fa889d-5412-487a-b6a9-21eb011c2384).
33+
The `add` element specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files, or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the <xref:System.Web.Compilation.BuildProviderAppliesToAttribute> class to specify whether the build provider applies to files in the App_Code directory, to files in a Web content directory, to global or local resources, or to all files. Use the `extension` attribute to specify the file extension used to identify files that the <xref:System.Web.Compilation.BuildProvider> class supports. Use the <xref:System.Web.Configuration.BuildProviderCollection> class to examine build providers in a configuration file. For more information about configuring a build provider, see [buildProviders Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/40fa889d-5412-487a-b6a9-21eb011c2384).
3434
3535
To implement a build provider that generates source code for a custom file type, derive a class from <xref:System.Web.Compilation.BuildProvider>, and override the <xref:System.Web.Compilation.BuildProvider.GenerateCode%2A> method to generate source code for the supported file type. The generated source is added to the <xref:System.Web.Compilation.AssemblyBuilder> object in the form of a CodeDOM graph, or as content that represents a physical source code file. If the build provider requires a specific programming language, override the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property to return a <xref:System.Web.Compilation.CompilerType> object for the supported programming language. If the build provider does not require a specific programming language, do not override the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property; use the base class implementation, which indicates that the build provider can use any .NET Framework language, such as Visual Basic or C#.
3636
@@ -276,7 +276,7 @@
276276
## Remarks
277277
Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in a build provider for a specific language name.
278278
279-
The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the `defaultLanguage` attribute value in the section of the application configuration file. If there is no default language setting in the compilation section, the default compiler type is set using the <xref:Microsoft.VisualBasic.VBCodeProvider> language provider.
279+
The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the `defaultLanguage` attribute value in the `compilation` section of the application configuration file. If there is no default language setting in the `compilation` section, the default compiler type is set using the <xref:Microsoft.VisualBasic.VBCodeProvider> language provider.
280280
281281
When deriving from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property within your implementation.
282282
@@ -315,7 +315,7 @@
315315
## Remarks
316316
Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in the build provider for a specific language name. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider.
317317
318-
The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the <xref:System.Web.Configuration.Compiler> elements in the <xref:System.Web.Configuration.CompilationSection.Compilers%2A> property of the <xref:System.Web.Configuration.CompilationSection> object for the configuration file. This is equivalent to examining the elements in the and the elements in the sections of the configuration file. For example, for the `language` value VB, the base class method returns a <xref:System.Web.Compilation.CompilerType> object that corresponds to the configured settings for an instance of <xref:Microsoft.VisualBasic.VBCodeProvider?displayProperty=nameWithType>.
318+
The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the <xref:System.Web.Configuration.Compiler> elements in the <xref:System.Web.Configuration.CompilationSection.Compilers%2A> property of the <xref:System.Web.Configuration.CompilationSection> object for the configuration file. This is equivalent to examining the `buildProviders` elements and the `compiler` elements in the `compilers` sections of the configuration file. For example, for the `language` value `VB`, the base class method returns a <xref:System.Web.Compilation.CompilerType> object that corresponds to the configured settings for an instance of <xref:Microsoft.VisualBasic.VBCodeProvider?displayProperty=nameWithType>.
319319
320320
When you derive from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property value for the language supported by your implementation.
321321
@@ -626,7 +626,7 @@
626626
<format type="text/markdown"><![CDATA[
627627
628628
## Remarks
629-
The ASP.NET build environment initializes the collection of assemblies that are available for reference by the build provider. The source code generated by a build provider can use public types in the referenced assemblies. The referenced assembly collection consists of other assemblies built in the ASP.NET application, and assemblies listed in the element in the configuration file.
629+
The ASP.NET build environment initializes the collection of assemblies that are available for reference by the build provider. The source code generated by a build provider can use public types in the referenced assemblies. The referenced assembly collection consists of other assemblies built in the ASP.NET application, and assemblies listed in the `assemblies` element in the configuration file.
630630
631631
If the build provider generates source code that references additional assemblies, the build provider adds the additional assemblies using the <xref:System.Web.Compilation.AssemblyBuilder.AddAssemblyReference%2A> method. The ASP.NET build environment resolves external types during assembly compilation using both the referenced assemblies added by build providers and the default collection of assemblies available for reference.
632632

0 commit comments

Comments
 (0)