[Mono-docs-list] What to do about types in the root namespace?

Mario Sopena Novales mario.sopena at gmail.com
Thu Dec 20 02:57:56 EST 2007


Hi,

   what about printing a big warning saying those classes A,B and C
won't be documented because they are not contained in a Namespace and
ignoring them when writing the documentation?

Mario

On 20/12/2007, Michael Hutchinson <m.j.hutchinson at gmail.com> wrote:
> On Dec 19, 2007 9:52 PM, Jonathan Pryor <jonpryor at vt.edu> wrote:
> > While trying to update the contents of monodoc/class, I ran into a
> > problem: Npgsql contains the following types in the root ("") namespace:
> > NpgsqlRowUpdatingEventArgs, and NpgsqlRowUpdatedEventArgs.
> >
> > The problem is twofold:
> >
> > 1. monodocer generates an error and exits if it sees such a type.
> > 2. What should Monodoc do with such a type?
> >
> > Assuming that telling the Npgsql authors to rename their types is
> > undesirable, we need a way to support types in the root namespace.
> ...
> > We could just say "Don't Do That," and be done with it. :-)
>
> Putting types in the root namespaces sounds to me like a Bad Thing,
> violating naming guidelines etc. IMO this isn't something that MonoDoc
> should care about -- if anything, it should throw an error (as it
> does) or ignore them.
>
> --
> Michael Hutchinson
> http://mjhutchinson.com
> _______________________________________________
> Mono-docs-list maillist  -  Mono-docs-list at lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-docs-list
>


More information about the Mono-docs-list mailing list