Author: miguel
Date: 2006-08-14 01:06:51 -0400 (Mon, 14 Aug 2006)
New Revision: 63699
Modified:
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthentication.xml
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthenticationTicket.xml
trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml
Log:
Do some documentation as I hack on monodoc/web
Modified: trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml
===================================================================
--- trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml 2006-08-14
03:49:08 UTC (rev 63698)
+++ trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml 2006-08-14
05:06:51 UTC (rev 63699)
@@ -26,8 +26,18 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the
<link location="node:gtk-sharp/programming/threads">Gtk# Thread
Programming</link> for details.</ThreadSafetyStatement>
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary>Represents an HTTP Cookie.</summary>
+ <remarks>
+ <para>
+You can use cookies to store information on the client browser that will be
provided in subsequent calls to the site. This can be useful to pass
information across pages, or to store small bits of information that might be
useful at a later time in the use of the web application
+</para>
+ <para>
+You could use it for example to store a transient user preference ("favorite
color", "default action when replying to an email" and so on).
+</para>
+ <para>
+Once constructed, the cookie can be send to the client by calling the <see
cref="M:HttpResponse.AppendCookie()" /> method. This must be done before any
input is sent back to the client.
+</para>
+ </remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@@ -47,7 +57,7 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
- <summary>To be added</summary>
+ <summary>Creates a cookie.</summary>
<param name="name">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'HttpCookie'</returns>
<remarks>To be added</remarks>
@@ -62,10 +72,11 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="name">To be added: an object of type 'string'</param>
- <param name="value">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'HttpCookie'</returns>
+ <summary>Creates a cookie with a given value.</summary>
+ <param name="name">The name of the cookie.
+</param>
+ <param name="value">The value of the cookie.</param>
+ <returns />
<remarks>To be added</remarks>
</Docs>
</Member>
Modified:
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthentication.xml
===================================================================
---
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthentication.xml
2006-08-14 03:49:08 UTC (rev 63698)
+++
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthentication.xml
2006-08-14 05:06:51 UTC (rev 63699)
@@ -75,9 +75,9 @@
<Parameter Name="encryptedTicket" Type="System.String" />
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="encryptedTicket">To be added: an object of type
'string'</param>
- <returns>To be added: an object of type
'FormsAuthenticationTicket'</returns>
+ <summary>Decrypts a string into a FormsAuthenticationTickets</summary>
+ <param name="encryptedTicket">The string to decode, it must have been
created with Encrypt.</param>
+ <returns>This will return a <see
cref="T:System.Web.Security.FormsAuthenticationTicket" /> or if the ticket
fails to validate (due to tampering) it will throw an <see
cref="T:System.ArgumentException" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@@ -91,10 +91,45 @@
<Parameter Name="ticket"
Type="System.Web.Security.FormsAuthenticationTicket" />
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="ticket">To be added: an object of type
'FormsAuthenticationTicket'</param>
- <returns>To be added: an object of type 'string'</returns>
- <remarks>To be added</remarks>
+ <summary>Encrypts the <see
cref="T:System.Web.Security.FormsAuthenticationTicket" /> based on the
configuration information for the application.</summary>
+ <param name="ticket">The ticket to encrypt.q</param>
+ <returns>
+ <para>
+A string representing the ticket. </para>
+ <para>
+The ticket might be just a string representation of the ticket, a string
representation with a checksum or string representation with a checksum and
encryption. Depending on the settings.
+</para>
+ </returns>
+ <remarks>
+ <para>The actual method to encrypt the data depends on the setting
in the "mode" attribute in the <authentication> section in the
<system.web> section of the application configuration.
+</para>
+ <para>
+The possible values are:
+</para>
+ <list type="table">
+ <listheader>
+ <term>Value</term>
+ <description>Effect</description>
+ </listheader>
+ <item>
+ <term>All</term>
+ <description>Checksums and encrypts the ticket; Prevents
tampering and visibility from the user</description>
+ </item>
+ <item>
+ <term>None</term>
+ <description>Encodes the tickets as a hex string, the ticket can
be tampered and the content viewed by a client</description>
+ </item>
+ <item>
+ <term>Encryption</term>
+ <description>Encrypts the tickets, but does not checksum the
results.</description>
+ </item>
+ <item>
+ <term>Validation</term>
+ <description>Appends a checksum to the sequence, to avoid a
client tampering with the data.</description>
+ </item>
+ </list>
+ <para>The default mode is "All".</para>
+ </remarks>
</Docs>
</Member>
<Member MemberName="Authenticate">
Modified:
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthenticationTicket.xml
===================================================================
---
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthenticationTicket.xml
2006-08-14 03:49:08 UTC (rev 63698)
+++
trunk/monodoc/class/System.Web/en/System.Web.Security/FormsAuthenticationTicket.xml
2006-08-14 05:06:51 UTC (rev 63699)
@@ -26,8 +26,15 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the
<link location="node:gtk-sharp/programming/threads">Gtk# Thread
Programming</link> for details.</ThreadSafetyStatement>
<Docs>
- <summary>To be added</summary>
- <remarks>To be added</remarks>
+ <summary />
+ <remarks>
+ <para>
+This class is used together with the FormsAuthentication infrastructure to
send information back to a client that needs to be either tamper-proof, or
encrypted.
+</para>
+ <para>
+This is usually used with the HTTP Cookie mechanism, you would create a
FormsAuthenticationTicket, storing the information that must be either
tamper-proof, or secret to the client. Once this information is created, you
would use the <see
cref="M:System.Web.Security.FormsAuthentication.Encrypt(System.Web.Security.FormsAuthenticationTicket)"
/> method to encrypt the data and send that information back to the client.
+</para>
+ </remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@@ -200,4 +207,4 @@
</Docs>
</Member>
</Members>
-</Type>
+</Type>
\ No newline at end of file
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches
