[Mono-docs-list] [PATCH] Generics Support for monodoc/tools

Jonathan Pryor jonpryor at vt.edu
Thu Oct 5 08:37:56 EDT 2006


On Thu, 2006-10-05 at 07:32 -0400, Joshua Tauberer wrote:
> Jonathan Pryor wrote:
> > On Wed, 2006-10-04 at 17:28 -0400, Joshua Tauberer wrote:
> >> Another thing... I wonder if it would make sense to rename the index.xml
> >> Name and File attributes to DisplayName and Signature to make what they
> >> represent clearer, and, I think, because the File attribute is used not
> >> just for file locations but also for matching signatures in crefs.
> > 
> > I'm not sure DisplayName is a significant improvement over Name.  I
> > actually prefer the shorter names, if possible.
> > 
> > You make a good argument for @File, though, as it's really used for all
> > type matching.  I don't like Signature though, as a "signature" is
> > frequently used to refer to the prototype of a method, and this is
> > something different.
> > 
> > Perhaps CanonicalName?
> 
> To me, it isn't obvious what the difference is between Name and
> CanonicalName.  There must be a name for what Type`1 is actually called,
> versus Type<A>.

Any other suggestions then?  I'd *love* to know the proper name for
Type`1.

Reading through ECMA-335, it looks like they don't distinguish between
generic type names and non-generic type names.  They're all type names.

So perhaps we should split the difference, as it were: rename the
current Name attribute to DisplayName, and add a new Name attribute
which holds the generic name:

	<Type Name="NonGeneric" DisplayName="NonGeneric" />
	<Type Name="Generic`1" DisplayName="Generic&lt;T&gt;" />

Thoughts?

 - Jon




More information about the Mono-docs-list mailing list