Merge pull request #920
[mono.git] / mcs / class / System.XML / Documentation / en / System.Xml.Schema / XmlSchemaType.xml
index 2a717367191ac42c8717ac273ee17b71771624aa..f15dbaadc12c1e073c94e8c12f9b64c480210241 100644 (file)
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <Type Name="XmlSchemaType" FullName="System.Xml.Schema.XmlSchemaType">
   <TypeSignature Maintainer="auto" Language="C#" Value="public class XmlSchemaType : System.Xml.Schema.XmlSchemaAnnotated" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XmlSchemaType extends System.Xml.Schema.XmlSchemaAnnotated" />
   </Base>
   <Interfaces />
   <Docs>
-    <summary>To be added</summary>
     <remarks>To be added</remarks>
+    <summary>
+      <attribution license="cc4" from="Microsoft" modified="false" />
+      <para>The base class for all simple types and complex types.</para>
+    </summary>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
         <remarks>To be added</remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaType" /> class.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="BaseSchemaType">
         <ReturnType>System.Object</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'object'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>The complexType is derived from the type specified by the base value. The base value must be a QName.</para>
+          <block subset="none" type="note">
+            <para>The <see cref="P:System.Xml.Schema.XmlSchemaType.BaseSchemaType" /> property is obsolete and has been replaced by the <see cref="P:System.Xml.Schema.XmlSchemaType.BaseXmlSchemaType" /> property.</para>
+          </block>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the post-compilation object type or the built-in XML Schema Definition Language (XSD) data type, simpleType element, or complexType element. This is a post-schema-compilation infoset property.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="BaseXmlSchemaType">
         <ReturnType>System.Xml.Schema.XmlSchemaType</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
         <value>To be added.</value>
-        <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>The <see cref="P:System.Xml.Schema.XmlSchemaType.BaseXmlSchemaType" /> property always has a value, because all schema types have a base type. This value is set upon schema compilation, making it a part of the post-schema-compilation infoset.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the post-compilation value for the base type of this schema type.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="Datatype">
         <ReturnType>System.Xml.Schema.XmlSchemaDatatype</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'XmlSchemaDatatype'</value>
         <remarks>To be added</remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the post-compilation value for the data type of the complex type.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="DerivedBy">
         <ReturnType>System.Xml.Schema.XmlSchemaDerivationMethod</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'XmlSchemaDerivationMethod'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>The following table shows the values that this property can contain.</para>
+          <list type="table">
+            <listheader>
+              <item>
+                <term>
+                  <para>
+                    <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> value</para>
+                </term>
+                <description>
+                  <para>Description </para>
+                </description>
+              </item>
+            </listheader>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.None" />
+                </para>
+              </term>
+              <description>
+                <para>No derivation method specified. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Substitution" />
+                </para>
+              </term>
+              <description>
+                <para>Derived by Substitution. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Extension" />
+                </para>
+              </term>
+              <description>
+                <para>Derived by Extension. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Restriction" />
+                </para>
+              </term>
+              <description>
+                <para>Derived by Restriction. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.List" />
+                </para>
+              </term>
+              <description>
+                <para>Derived by List. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Union" />
+                </para>
+              </term>
+              <description>
+                <para>Derived by Union. </para>
+              </description>
+            </item>
+          </list>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the post-compilation information on how this element was derived from its base type.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="Final">
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'XmlSchemaDerivationMethod'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>The following table shows the values that this property can contain for simple type.</para>
+          <list type="table">
+            <listheader>
+              <item>
+                <term>
+                  <para>
+                    <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> value</para>
+                </term>
+                <description>
+                  <para>Description </para>
+                </description>
+              </item>
+            </listheader>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Empty" />
+                </para>
+              </term>
+              <description>
+                <para>Overrides the schema blockDefault setting allowing any derivations by restriction, extension, or substitution to take place. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.None" />
+                </para>
+              </term>
+              <description>
+                <para>No derivation method is specified. This is the default. Derivation rules are taken from the schema blockDefault setting. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Substitution" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Substitution. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Extension" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Extension. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Restriction" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Restriction. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.All" />
+                </para>
+              </term>
+              <description>
+                <para>#all. Cannot be replaced by a type derived by any derivation method. </para>
+              </description>
+            </item>
+          </list>
+          <para>The following table shows the values that this property can contain for complex type.</para>
+          <list type="table">
+            <listheader>
+              <item>
+                <term>
+                  <para>
+                    <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> value</para>
+                </term>
+                <description>
+                  <para>Description </para>
+                </description>
+              </item>
+            </listheader>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Empty" />
+                </para>
+              </term>
+              <description>
+                <para>Overrides the schema blockDefault setting allowing any derivations by restriction, extension, or substitution to take place. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.None" />
+                </para>
+              </term>
+              <description>
+                <para>No derivation method is specified. This is the default. Derivation rules are taken from the schema blockDefault setting. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Substitution" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Substitution. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Extension" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Extension. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.Restriction" />
+                </para>
+              </term>
+              <description>
+                <para>Cannot be replaced by a type derived by Restriction. </para>
+              </description>
+            </item>
+            <item>
+              <term>
+                <para>
+                  <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.All" />
+                </para>
+              </term>
+              <description>
+                <para>#all. Cannot be replaced by a type derived by any derivation method. </para>
+              </description>
+            </item>
+          </list>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets or sets the final attribute of the type derivation that indicates if further derivations are allowed.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="FinalResolved">
         <ReturnType>System.Xml.Schema.XmlSchemaDerivationMethod</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'XmlSchemaDerivationMethod'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>This value indicates how the type is restricted when the type is extended through restriction. If the type is marked as final, this type cannot be extended.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the post-compilation value of the <see cref="P:System.Xml.Schema.XmlSchemaType.Final" /> property.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="GetBuiltInComplexType">
         <Parameter Name="typeCode" Type="System.Xml.Schema.XmlTypeCode" />
       </Parameters>
       <Docs>
-        <param name="typeCode">To be added.</param>
-        <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Returns an <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> that represents the built-in complex type of the complex type specified.</para>
+        </summary>
+        <param name="typeCode">
+          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Xml.Schema.XmlTypeCode" /> values representing the complex type.</param>
       </Docs>
     </Member>
     <Member MemberName="GetBuiltInComplexType">
         <Parameter Name="qualifiedName" Type="System.Xml.XmlQualifiedName" />
       </Parameters>
       <Docs>
-        <param name="qualifiedName">To be added.</param>
-        <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Returns an <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> that represents the built-in complex type of the complex type specified by qualified name.</para>
+        </summary>
+        <param name="qualifiedName">
+          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlQualifiedName" /> of the complex type.</param>
       </Docs>
     </Member>
     <Member MemberName="GetBuiltInSimpleType">
         <Parameter Name="typeCode" Type="System.Xml.Schema.XmlTypeCode" />
       </Parameters>
       <Docs>
-        <param name="typeCode">To be added.</param>
-        <summary>To be added.</summary>
         <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>You cannot directly serialize the built-in type. If you need to serialize the type, create a new simple type which derives from the built-in type and serialize the simple type.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Returns an <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" /> that represents the built-in simple type of the specified simple type.</para>
+        </summary>
+        <param name="typeCode">
+          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Xml.Schema.XmlTypeCode" /> values representing the simple type.</param>
       </Docs>
     </Member>
     <Member MemberName="GetBuiltInSimpleType">
         <Parameter Name="qualifiedName" Type="System.Xml.XmlQualifiedName" />
       </Parameters>
       <Docs>
-        <param name="qualifiedName">To be added.</param>
-        <summary>To be added.</summary>
         <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>You cannot directly serialize the built-in type. If you need to serialize the type, create a new simple type which derives from the built-in type and serialize the simple type.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Returns an <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" /> that represents the built-in simple type of the simple type that is specified by the qualified name.</para>
+        </summary>
+        <param name="qualifiedName">
+          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlQualifiedName" /> of the simple type.</param>
       </Docs>
     </Member>
     <Member MemberName="IsDerivedFrom">
         <Parameter Name="except" Type="System.Xml.Schema.XmlSchemaDerivationMethod" />
       </Parameters>
       <Docs>
-        <param name="derivedType">To be added.</param>
-        <param name="baseType">To be added.</param>
-        <param name="except">To be added.</param>
-        <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Returns a value indicating if the derived schema type specified is derived from the base schema type specified</para>
+        </summary>
+        <param name="derivedType">
+          <attribution license="cc4" from="Microsoft" modified="false" />The derived <see cref="T:System.Xml.Schema.XmlSchemaType" /> to test.</param>
+        <param name="baseType">
+          <attribution license="cc4" from="Microsoft" modified="false" />The base <see cref="T:System.Xml.Schema.XmlSchemaType" /> to test the derived <see cref="T:System.Xml.Schema.XmlSchemaType" /> against.</param>
+        <param name="except">
+          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> values representing a type derivation method to exclude from testing.</param>
       </Docs>
     </Member>
     <Member MemberName="IsMixed">
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'bool'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>This virtual method is overridden in derived classes.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets or sets a value indicating if this type has a mixed content model. This property is only valid in a complex type.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="Name">
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'string'</value>
-        <remarks>To be added</remarks>
+        <remarks>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>The name must be an no-colon name (NCName) as defined in the World Wide Web Consortium (W3C) XML Namespaces specification. If specified, the name must be unique among all simpleType and complexType elements.</para>
+        </remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets or sets the name of the type.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="QualifiedName">
         <ReturnType>System.Xml.XmlQualifiedName</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
         <value>To be added: an object of type 'System.Xml.XmlQualifiedName'</value>
         <remarks>To be added</remarks>
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the qualified name for the type built from the Name attribute of this type. This is a post-schema-compilation property.</para>
+        </summary>
       </Docs>
     </Member>
     <Member MemberName="TypeCode">
         <ReturnType>System.Xml.Schema.XmlTypeCode</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
         <value>To be added.</value>
         <remarks>To be added.</remarks>
         <since version=".NET 2.0" />
+        <summary>
+          <attribution license="cc4" from="Microsoft" modified="false" />
+          <para>Gets the <see cref="T:System.Xml.Schema.XmlTypeCode" /> of the type.</para>
+        </summary>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
\ No newline at end of file