[Mono-dev] Patches. One exception raising and alot of xmldoc cleanups.

Jonathan Pryor jonpryor at vt.edu
Sun Apr 23 17:41:25 EDT 2006


On Sun, 2006-04-23 at 08:26 -0400, Justin Dearing wrote:
> Ok I have a few patches here. The biggest one is for LdapCOnnection. First
> of all I updated all the exception xml comments like so:
> 
> -<exception> LdapException Thrown if TLS cannot be started.  If a
> <exception cref="LdapException">Thrown if TLS cannot be

Most of the ECMA documentation I've seen would do something like this
instead:

	<exception cref="Novell.Directory.Ldap.LdapException">
		Thrown if TLS cannot be started.  If a 
		<see cref="Novell.Directory.Ldap.LdapException"/> 
		thrown...
	</exception>

That is, inline text uses <see/>, while <exception> has an @cref
attribute.  This is for use within the Exception blocks (e.g. "this
method can generate the following exceptions...").

 - Jon





More information about the Mono-devel-list mailing list