mcs/bmcs/doc.cs

   1 //
   2 // doc.cs: Support for XML documentation comment.
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Licensed under the terms of the GNU GPL
   8 //
   9 // (C) 2004 Novell, Inc.
  10 //
  11 //
  12 using System;
  13 using System.Collections;
  14 using System.Collections.Specialized;
  15 using System.IO;
  16 using System.Reflection;
  17 using System.Reflection.Emit;
  18 using System.Runtime.CompilerServices;
  19 using System.Runtime.InteropServices;
  20 using System.Security;
  21 using System.Security.Permissions;
  22 using System.Text;
  23 using System.Xml;
  24
  25 using Mono.CompilerServices.SymbolWriter;
  26
  27 namespace Mono.CSharp {
  28
  29         //
  30         // Support class for XML documentation.
  31         //
  32         public static class DocUtil
  33         {
  34                 // TypeContainer
  35
  36                 //
  37                 // Generates xml doc comments (if any), and if required,
  38                 // handle warning report.
  39                 //
  40                 internal static void GenerateTypeDocComment (TypeContainer t,
  41                         DeclSpace ds)
  42                 {
  43                         GenerateDocComment (t, ds);
  44
  45                         if (t.DefaultStaticConstructor != null)
  46                                 t.DefaultStaticConstructor.GenerateDocComment (t);
  47
  48                         if (t.InstanceConstructors != null)
  49                                 foreach (Constructor c in t.InstanceConstructors)
  50                                         c.GenerateDocComment (t);
  51
  52                         if (t.Types != null)
  53                                 foreach (TypeContainer tc in t.Types)
  54                                         tc.GenerateDocComment (t);
  55
  56                         if (t.Parts != null) {
  57                                 IDictionary comments = RootContext.Documentation.PartialComments;
  58                                 foreach (ClassPart cp in t.Parts) {
  59                                         if (cp.DocComment == null)
  60                                                 continue;
  61                                         comments [cp] = cp;
  62                                 }
  63                         }
  64
  65                         if (t.Enums != null)
  66                                 foreach (Enum en in t.Enums)
  67                                         en.GenerateDocComment (t);
  68
  69                         if (t.Constants != null)
  70                                 foreach (Const c in t.Constants)
  71                                         c.GenerateDocComment (t);
  72
  73                         if (t.Fields != null)
  74                                 foreach (Field f in t.Fields)
  75                                         f.GenerateDocComment (t);
  76
  77                         if (t.Events != null)
  78                                 foreach (Event e in t.Events)
  79                                         e.GenerateDocComment (t);
  80
  81                         if (t.Indexers != null)
  82                                 foreach (Indexer ix in t.Indexers)
  83                                         ix.GenerateDocComment (t);
  84
  85                         if (t.Properties != null)
  86                                 foreach (Property p in t.Properties)
  87                                         p.GenerateDocComment (t);
  88
  89                         if (t.Methods != null)
  90                                 foreach (Method m in t.Methods)
  91                                         m.GenerateDocComment (t);
  92
  93                         if (t.Operators != null)
  94                                 foreach (Operator o in t.Operators)
  95                                         o.GenerateDocComment (t);
  96                 }
  97
  98                 // MemberCore
  99                 private static readonly string lineHead =
 100                         Environment.NewLine + "            ";
 101
 102                 private static XmlNode GetDocCommentNode (MemberCore mc,
 103                         string name)
 104                 {
 105                         // FIXME: It could be even optimizable as not
 106                         // to use XmlDocument. But anyways the nodes
 107                         // are not kept in memory.
 108                         XmlDocument doc = RootContext.Documentation.XmlDocumentation;
 109                         try {
 110                                 XmlElement el = doc.CreateElement ("member");
 111                                 el.SetAttribute ("name", name);
 112                                 string normalized = mc.DocComment;
 113                                 el.InnerXml = normalized;
 114                                 // csc keeps lines as written in the sources
 115                                 // and inserts formatting indentation (which
 116                                 // is different from XmlTextWriter.Formatting
 117                                 // one), but when a start tag contains an
 118                                 // endline, it joins the next line. We don't
 119                                 // have to follow such a hacky behavior.
 120                                 string [] split =
 121                                         normalized.Split ('\n');
 122                                 int j = 0;
 123                                 for (int i = 0; i < split.Length; i++) {
 124                                         string s = split [i].TrimEnd ();
 125                                         if (s.Length > 0)
 126                                                 split [j++] = s;
 127                                 }
 128                                 el.InnerXml = lineHead + String.Join (
 129                                         lineHead, split, 0, j);
 130                                 return el;
 131                         } catch (XmlException ex) {
 132                                 Report.Warning (1570, 1, mc.Location, "XML comment on '{0}' has non-well-formed XML ({1}).", name, ex.Message);
 133                                 XmlComment com = doc.CreateComment (String.Format ("FIXME: Invalid documentation markup was found for member {0}", name));
 134                                 return com;
 135                         }
 136                 }
 137
 138                 //
 139                 // Generates xml doc comments (if any), and if required,
 140                 // handle warning report.
 141                 //
 142                 internal static void GenerateDocComment (MemberCore mc,
 143                         DeclSpace ds)
 144                 {
 145                         if (mc.DocComment != null) {
 146                                 string name = mc.GetDocCommentName (ds);
 147
 148                                 XmlNode n = GetDocCommentNode (mc, name);
 149
 150                                 XmlElement el = n as XmlElement;
 151                                 if (el != null) {
 152                                         mc.OnGenerateDocComment (ds, el);
 153
 154                                         // FIXME: it could be done with XmlReader
 155                                         foreach (XmlElement inc in n.SelectNodes (".//include"))
 156                                                 HandleInclude (mc, inc);
 157
 158                                         // FIXME: it could be done with XmlReader
 159                                         DeclSpace dsTarget = mc as DeclSpace;
 160                                         if (dsTarget == null)
 161                                                 dsTarget = ds;
 162
 163                                         foreach (XmlElement see in n.SelectNodes (".//see"))
 164                                                 HandleSee (mc, dsTarget, see);
 165                                         foreach (XmlElement seealso in n.SelectNodes (".//seealso"))
 166                                                 HandleSeeAlso (mc, dsTarget, seealso);
 167                                         foreach (XmlElement see in n.SelectNodes (".//exception"))
 168                                                 HandleException (mc, dsTarget, see);
 169                                 }
 170
 171                                 n.WriteTo (RootContext.Documentation.XmlCommentOutput);
 172                         }
 173                         else if (mc.IsExposedFromAssembly (ds)) {
 174                                 Constructor c = mc as Constructor;
 175                                 if (c == null || !c.IsDefault ())
 176                                         Report.Warning (1591, 4, mc.Location,
 177                                                 "Missing XML comment for publicly visible type or member '{0}'", mc.GetSignatureForError ());
 178                         }
 179                 }
 180
 181                 //
 182                 // Processes "include" element. Check included file and
 183                 // embed the document content inside this documentation node.
 184                 //
 185                 private static void HandleInclude (MemberCore mc, XmlElement el)
 186                 {
 187                         string file = el.GetAttribute ("file");
 188                         string path = el.GetAttribute ("path");
 189                         if (file == "") {
 190                                 Report.Warning (1590, 1, mc.Location, "Invalid XML 'include' element; Missing 'file' attribute.");
 191                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el);
 192                         }
 193                         else if (path == "") {
 194                                 Report.Warning (1590, 1, mc.Location, "Invalid XML 'include' element; Missing 'path' attribute.");
 195                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Include tag is invalid "), el);
 196                         }
 197                         else {
 198                                 XmlDocument doc = RootContext.Documentation.StoredDocuments [file] as XmlDocument;
 199                                 if (doc == null) {
 200                                         try {
 201                                                 doc = new XmlDocument ();
 202                                                 doc.Load (file);
 203                                                 RootContext.Documentation.StoredDocuments.Add (file, doc);
 204                                         } catch (Exception) {
 205                                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (String.Format (" Badly formed XML in at comment file '{0}': cannot be included ", file)), el);
 206                                                 Report.Warning (1592, 1, mc.Location, "Badly formed XML in included comments file -- '{0}'", file);
 207                                         }
 208                                 }
 209                                 bool keepIncludeNode = false;
 210                                 if (doc != null) {
 211                                         try {
 212                                                 XmlNodeList nl = doc.SelectNodes (path);
 213                                                 if (nl.Count == 0) {
 214                                                         el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" No matching elements were found for the include tag embedded here. "), el);
 215
 216                                                         keepIncludeNode = true;
 217                                                 }
 218                                                 foreach (XmlNode n in nl)
 219                                                         el.ParentNode.InsertBefore (el.OwnerDocument.ImportNode (n, true), el);
 220                                         } catch (Exception ex) {
 221                                                 el.ParentNode.InsertBefore (el.OwnerDocument.CreateComment (" Failed to insert some or all of included XML "), el);
 222                                                 Report.Warning (1589, 1, mc.Location, "Unable to include XML fragment '{0}' of file {1} -- {2}.", path, file, ex.Message);
 223                                         }
 224                                 }
 225                                 if (!keepIncludeNode)
 226                                         el.ParentNode.RemoveChild (el);
 227                         }
 228                 }
 229
 230                 //
 231                 // Handles <see> elements.
 232                 //
 233                 private static void HandleSee (MemberCore mc,
 234                         DeclSpace ds, XmlElement see)
 235                 {
 236                         HandleXrefCommon (mc, ds, see);
 237                 }
 238
 239                 //
 240                 // Handles <seealso> elements.
 241                 //
 242                 private static void HandleSeeAlso (MemberCore mc,
 243                         DeclSpace ds, XmlElement seealso)
 244                 {
 245                         HandleXrefCommon (mc, ds, seealso);
 246                 }
 247
 248                 //
 249                 // Handles <exception> elements.
 250                 //
 251                 private static void HandleException (MemberCore mc,
 252                         DeclSpace ds, XmlElement seealso)
 253                 {
 254                         HandleXrefCommon (mc, ds, seealso);
 255                 }
 256
 257                 static readonly char [] wsChars =
 258                         new char [] {' ', '\t', '\n', '\r'};
 259
 260                 //
 261                 // returns a full runtime type name from a name which might
 262                 // be C# specific type name.
 263                 //
 264                 private static Type FindDocumentedType (MemberCore mc, string name, DeclSpace ds, string cref)
 265                 {
 266                         bool isArray = false;
 267                         string identifier = name;
 268                         if (name [name.Length - 1] == ']') {
 269                                 string tmp = name.Substring (0, name.Length - 1).Trim (wsChars);
 270                                 if (tmp [tmp.Length - 1] == '[') {
 271                                         identifier = tmp.Substring (0, tmp.Length - 1).Trim (wsChars);
 272                                         isArray = true;
 273                                 }
 274                         }
 275                         Type t = FindDocumentedTypeNonArray (mc, identifier, ds, cref);
 276                         if (t != null && isArray)
 277                                 t = Array.CreateInstance (t, 0).GetType ();
 278                         return t;
 279                 }
 280
 281                 private static Type FindDocumentedTypeNonArray (MemberCore mc,
 282                         string identifier, DeclSpace ds, string cref)
 283                 {
 284                         switch (identifier) {
 285                         case "int":
 286                                 return typeof (int);
 287                         case "uint":
 288                                 return typeof (uint);
 289                         case "short":
 290                                 return typeof (short);
 291                         case "ushort":
 292                                 return typeof (ushort);
 293                         case "long":
 294                                 return typeof (long);
 295                         case "ulong":
 296                                 return typeof (ulong);
 297                         case "float":
 298                                 return typeof (float);
 299                         case "double":
 300                                 return typeof (double);
 301                         case "char":
 302                                 return typeof (char);
 303                         case "decimal":
 304                                 return typeof (decimal);
 305                         case "byte":
 306                                 return typeof (byte);
 307                         case "sbyte":
 308                                 return typeof (sbyte);
 309                         case "object":
 310                                 return typeof (object);
 311                         case "bool":
 312                                 return typeof (bool);
 313                         case "string":
 314                                 return typeof (string);
 315                         case "void":
 316                                 return typeof (void);
 317                         }
 318                         FullNamedExpression e = ds.FindType (mc.Location, identifier);
 319                         if (e != null) {
 320                                 if (!(e is TypeExpr))
 321                                         return null;
 322                                 return ((TypeExpr) e).ResolveType (ds.EmitContext);
 323                         }
 324                         int index = identifier.LastIndexOf ('.');
 325                         if (index < 0)
 326                                 return null;
 327                         int warn;
 328                         Type parent = FindDocumentedType (mc, identifier.Substring (0, index), ds, cref);
 329                         if (parent == null)
 330                                 return null;
 331                         return FindDocumentedMember (mc, parent,
 332                                 identifier.Substring (index + 1),
 333                                 Type.EmptyTypes,
 334                                 ds, out warn, cref) as Type;
 335                 }
 336
 337                 //
 338                 // Returns a MemberInfo that is referenced in XML documentation
 339                 // (by "see" or "seealso" elements).
 340                 //
 341                 private static MemberInfo FindDocumentedMember (MemberCore mc,
 342                         Type type, string memberName, Type [] paramList,
 343                         DeclSpace ds, out int warningType, string cref)
 344                 {
 345                         warningType = 0;
 346                         MethodSignature msig = new MethodSignature (memberName, null, paramList);
 347                         MemberInfo [] mis = type.FindMembers (
 348                                 MemberTypes.All,
 349                                 BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
 350                                 MethodSignature.method_signature_filter,
 351                                 msig);
 352                         if (mis.Length > 0)
 353                                 return mis [0];
 354
 355                         if (paramList.Length == 0) {
 356                                 // search for fields/events etc.
 357                                 mis = type.FindMembers (
 358                                         MemberTypes.All,
 359                                         BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance,
 360                                         Type.FilterName,
 361                                         memberName);
 362                                 return (mis.Length > 0) ? mis [0] : null;
 363                         }
 364
 365                         // search for operators (whose parameters exactly
 366                         // matches with the list) and possibly report CS1581.
 367                         string oper = null;
 368                         string returnTypeName = null;
 369                         if (memberName.StartsWith ("implicit operator ")) {
 370                                 oper = "op_Implicit";
 371                                 returnTypeName = memberName.Substring (18).Trim (wsChars);
 372                         }
 373                         else if (memberName.StartsWith ("explicit operator ")) {
 374                                 oper = "op_Explicit";
 375                                 returnTypeName = memberName.Substring (18).Trim (wsChars);
 376                         }
 377                         else if (memberName.StartsWith ("operator ")) {
 378                                 oper = memberName.Substring (9).Trim (wsChars);
 379                                 switch (oper) {
 380                                 // either unary or binary
 381                                 case "+":
 382                                         oper = paramList.Length == 2 ?
 383                                                 Binary.oper_names [(int) Binary.Operator.Addition] :
 384                                                 Unary.oper_names [(int) Unary.Operator.UnaryPlus];
 385                                         break;
 386                                 case "-":
 387                                         oper = paramList.Length == 2 ?
 388                                                 Binary.oper_names [(int) Binary.Operator.Subtraction] :
 389                                                 Unary.oper_names [(int) Unary.Operator.UnaryNegation];
 390                                         break;
 391                                 // unary
 392                                 case "!":
 393                                         oper = Unary.oper_names [(int) Unary.Operator.LogicalNot]; break;
 394                                 case "~":
 395                                         oper = Unary.oper_names [(int) Unary.Operator.OnesComplement]; break;
 396
 397                                 case "++":
 398                                         oper = "op_Increment"; break;
 399                                 case "--":
 400                                         oper = "op_Decrement"; break;
 401                                 case "true":
 402                                         oper = "op_True"; break;
 403                                 case "false":
 404                                         oper = "op_False"; break;
 405                                 // binary
 406                                 case "*":
 407                                         oper = Binary.oper_names [(int) Binary.Operator.Multiply]; break;
 408                                 case "/":
 409                                         oper = Binary.oper_names [(int) Binary.Operator.Division]; break;
 410                                 case "%":
 411                                         oper = Binary.oper_names [(int) Binary.Operator.Modulus]; break;
 412                                 case "&":
 413                                         oper = Binary.oper_names [(int) Binary.Operator.BitwiseAnd]; break;
 414                                 case "|":
 415                                         oper = Binary.oper_names [(int) Binary.Operator.BitwiseOr]; break;
 416                                 case "^":
 417                                         oper = Binary.oper_names [(int) Binary.Operator.ExclusiveOr]; break;
 418                                 case "<<":
 419                                         oper = Binary.oper_names [(int) Binary.Operator.LeftShift]; break;
 420                                 case ">>":
 421                                         oper = Binary.oper_names [(int) Binary.Operator.RightShift]; break;
 422                                 case "==":
 423                                         oper = Binary.oper_names [(int) Binary.Operator.Equality]; break;
 424                                 case "!=":
 425                                         oper = Binary.oper_names [(int) Binary.Operator.Inequality]; break;
 426                                 case "<":
 427                                         oper = Binary.oper_names [(int) Binary.Operator.LessThan]; break;
 428                                 case ">":
 429                                         oper = Binary.oper_names [(int) Binary.Operator.GreaterThan]; break;
 430                                 case "<=":
 431                                         oper = Binary.oper_names [(int) Binary.Operator.LessThanOrEqual]; break;
 432                                 case ">=":
 433                                         oper = Binary.oper_names [(int) Binary.Operator.GreaterThanOrEqual]; break;
 434                                 default:
 435                                         warningType = 1584;
 436                                         Report.Warning (1020, 1, mc.Location, "Overloadable {0} operator is expected", paramList.Length == 2 ? "binary" : "unary");
 437                                         Report.Warning (1584, 1, mc.Location, "XML comment on '{0}' has syntactically incorrect attribute '{1}'", mc.GetSignatureForError (), cref);
 438                                         return null;
 439                                 }
 440                         }
 441                         // here we still does not consider return type (to
 442                         // detect CS1581 or CS1002+CS1584).
 443                         msig = new MethodSignature (oper, null, paramList);
 444                         mis = type.FindMembers (
 445                                 MemberTypes.Method,
 446                                 BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static,
 447                                 MethodSignature.method_signature_filter,
 448                                 msig);
 449                         if (mis.Length == 0)
 450                                 return null; // CS1574
 451                         MemberInfo mi = mis [0];
 452                         Type expected = mi is MethodInfo ?
 453                                 ((MethodInfo) mi).ReturnType :
 454                                 mi is PropertyInfo ?
 455                                 ((PropertyInfo) mi).PropertyType :
 456                                 null;
 457                         if (returnTypeName != null) {
 458                                 Type returnType = FindDocumentedType (mc, returnTypeName, ds, cref);
 459                                 if (returnType == null || returnType != expected) {
 460                                         warningType = 1581;
 461                                         Report.Warning (1581, 1, mc.Location, "Invalid return type in XML comment cref attribute '{0}'", cref);
 462                                         return null;
 463                                 }
 464                         }
 465                         return mis [0];
 466                 }
 467
 468                 //
 469                 // Processes "see" or "seealso" elements.
 470                 // Checks cref attribute.
 471                 //
 472                 private static void HandleXrefCommon (MemberCore mc,
 473                         DeclSpace ds, XmlElement xref)
 474                 {
 475                         string cref = xref.GetAttribute ("cref").Trim (wsChars);
 476                         // when, XmlReader, "if (cref == null)"
 477                         if (!xref.HasAttribute ("cref"))
 478                                 return;
 479                         if (cref.Length == 0)
 480                                 Report.Warning (1001, 1, mc.Location, "Identifier expected");
 481                                 // ... and continue until CS1584.
 482
 483                         string signature; // "x:" are stripped
 484                         string name; // method invokation "(...)" are removed
 485                         string parameters; // method parameter list
 486
 487                         // strip 'T:' 'M:' 'F:' 'P:' 'E:' etc.
 488                         // Here, MS ignores its member kind. No idea why.
 489                         if (cref.Length > 2 && cref [1] == ':')
 490                                 signature = cref.Substring (2).Trim (wsChars);
 491                         else
 492                                 signature = cref;
 493
 494                         int parensPos = signature.IndexOf ('(');
 495                         if (parensPos > 0 && signature [signature.Length - 1] == ')') {
 496                                 name = signature.Substring (0, parensPos).Trim (wsChars);
 497                                 parameters = signature.Substring (parensPos + 1, signature.Length - parensPos - 2);
 498                         }
 499                         else {
 500                                 name = signature;
 501                                 parameters = String.Empty;
 502                         }
 503
 504                         string identifier = name;
 505
 506                         if (name.Length > 0 && name [name.Length - 1] == ']') {
 507                                 string tmp = name.Substring (0, name.Length - 1).Trim (wsChars);
 508                                 if (tmp [tmp.Length - 1] == '[')
 509                                         identifier = tmp.Substring (0, tmp.Length - 1).Trim (wsChars);
 510                         }
 511
 512                         // Check if identifier is valid.
 513                         // This check is not necessary to mark as error, but
 514                         // csc specially reports CS1584 for wrong identifiers.
 515                         foreach (string nameElem in identifier.Split ('.')) {
 516                                 if (!Tokenizer.IsValidIdentifier (nameElem)
 517                                         && nameElem.IndexOf ("operator") < 0) {
 518                                         if (nameElem.EndsWith ("[]") &&
 519                                                 Tokenizer.IsValidIdentifier (
 520                                                 nameElem.Substring (
 521                                                 0, nameElem.Length - 2)))
 522                                                 continue;
 523
 524                                         Report.Warning (1584, 1, mc.Location, "XML comment on '{0}' has syntactically incorrect attribute '{1}'", mc.GetSignatureForError (), cref);
 525                                         xref.SetAttribute ("cref", "!:" + signature);
 526                                         return;
 527                                 }
 528                         }
 529
 530                         // check if parameters are valid
 531                         Type [] parameterTypes = Type.EmptyTypes;
 532                         if (parameters.Length > 0) {
 533                                 string [] paramList = parameters.Split (',');
 534                                 ArrayList plist = new ArrayList ();
 535                                 for (int i = 0; i < paramList.Length; i++) {
 536                                         string paramTypeName = paramList [i].Trim (wsChars);
 537                                         Type paramType = FindDocumentedType (mc, paramTypeName, ds, cref);
 538                                         if (paramType == null) {
 539                                                 Report.Warning (1580, 1, mc.Location, "Invalid type for parameter '{0}' in XML comment cref attribute '{1}'", i + 1, cref);
 540                                                 return;
 541                                         }
 542                                         plist.Add (paramType);
 543                                 }
 544                                 parameterTypes = plist.ToArray (typeof (Type)) as Type [];
 545                                 StringBuilder sb = new StringBuilder ();
 546                                 sb.Append ('(');
 547                                 for (int i = 0; i < parameterTypes.Length; i++) {
 548                                         Type t = parameterTypes [i];
 549                                         if (sb.Length > 1)
 550                                                 sb.Append (',');
 551                                         sb.Append (t.FullName.Replace ('+', '.'));
 552                                 }
 553                                 sb.Append (')');
 554                                 parameters = sb.ToString ();
 555                         }
 556
 557                         Type type = FindDocumentedType (mc, name, ds, cref);
 558                         if (type != null) {
 559                                 xref.SetAttribute ("cref", "T:" + type.FullName.Replace ("+", "."));
 560                                 return; // a type
 561                         }
 562
 563                         // don't use identifier here. System[] is not alloed.
 564                         if (Namespace.IsNamespace (name)) {
 565                                 xref.SetAttribute ("cref", "N:" + name);
 566                                 return; // a namespace
 567                         }
 568
 569                         int period = name.LastIndexOf ('.');
 570                         if (period > 0) {
 571                                 string typeName = name.Substring (0, period);
 572                                 string memberName = name.Substring (period + 1);
 573                                 type = FindDocumentedType (mc, typeName, ds, cref);
 574                                 int warnResult;
 575                                 if (type != null) {
 576                                         MemberInfo mi = FindDocumentedMember (mc, type, memberName, parameterTypes, ds, out warnResult, cref);
 577                                         if (warnResult > 0)
 578                                                 return;
 579                                         if (mi != null) {
 580                                                 xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + type.FullName.Replace ("+", ".") + "." + memberName + parameters);
 581                                                 return; // a member of a type
 582                                         }
 583                                 }
 584                         }
 585                         else {
 586                                 int warnResult;
 587                                 MemberInfo mi = FindDocumentedMember (mc, ds.TypeBuilder, name, parameterTypes, ds, out warnResult, cref);
 588                                 if (warnResult > 0)
 589                                         return;
 590                                 if (mi != null) {
 591                                         xref.SetAttribute ("cref", GetMemberDocHead (mi.MemberType) + ds.TypeBuilder.FullName.Replace ("+", ".") + "." + name);
 592                                         return; // local member name
 593                                 }
 594                         }
 595
 596                         Report.Warning (1574, 1, mc.Location, "XML comment on '{0}' has cref attribute '{1}' that could not be resolved in '{2}'.", mc.GetSignatureForError (), cref, ds.GetSignatureForError ());
 597
 598                         xref.SetAttribute ("cref", "!:" + name);
 599                 }
 600
 601                 //
 602                 // Get a prefix from member type for XML documentation (used
 603                 // to formalize cref target name).
 604                 //
 605                 static string GetMemberDocHead (MemberTypes type)
 606                 {
 607                         switch (type) {
 608                         case MemberTypes.Constructor:
 609                         case MemberTypes.Method:
 610                                 return "M:";
 611                         case MemberTypes.Event:
 612                                 return "E:";
 613                         case MemberTypes.Field:
 614                                 return "F:";
 615                         case MemberTypes.NestedType:
 616                         case MemberTypes.TypeInfo:
 617                                 return "T:";
 618                         case MemberTypes.Property:
 619                                 return "P:";
 620                         }
 621                         return "!:";
 622                 }
 623
 624                 // MethodCore
 625
 626                 //
 627                 // Returns a string that represents the signature for this
 628                 // member which should be used in XML documentation.
 629                 //
 630                 public static string GetMethodDocCommentName (MethodCore mc, DeclSpace ds)
 631                 {
 632                         Parameter [] plist = mc.Parameters.FixedParameters;
 633                         Parameter parr = mc.Parameters.ArrayParameter;
 634                         string paramSpec = String.Empty;
 635                         if (plist != null) {
 636                                 StringBuilder psb = new StringBuilder ();
 637                                 foreach (Parameter p in plist) {
 638                                         psb.Append (psb.Length != 0 ? "," : "(");
 639                                         psb.Append (p.ParameterType.FullName.Replace ("+", "."));
 640                                 }
 641                                 paramSpec = psb.ToString ();
 642                         }
 643                         if (parr != null)
 644                                 paramSpec += String.Concat (
 645                                         paramSpec == String.Empty ? "(" : ",",
 646                                         parr.ParameterType.FullName.Replace ("+", "."));
 647
 648                         if (paramSpec.Length > 0)
 649                                 paramSpec += ")";
 650
 651                         string name = mc is Constructor ? "#ctor" : mc.Name;
 652                         string suffix = String.Empty;
 653                         Operator op = mc as Operator;
 654                         if (op != null) {
 655                                 switch (op.OperatorType) {
 656                                 case Operator.OpType.Implicit:
 657                                 case Operator.OpType.Explicit:
 658                                         suffix = "~" + op.OperatorMethodBuilder.ReturnType.FullName.Replace ('+', '.');
 659                                         break;
 660                                 }
 661                         }
 662                         return String.Concat (mc.DocCommentHeader, ds.Name, ".", name, paramSpec, suffix);
 663                 }
 664
 665                 //
 666                 // Raised (and passed an XmlElement that contains the comment)
 667                 // when GenerateDocComment is writing documentation expectedly.
 668                 //
 669                 // FIXME: with a few effort, it could be done with XmlReader,
 670                 // that means removal of DOM use.
 671                 //
 672                 internal static void OnMethodGenerateDocComment (
 673                         MethodCore mc, DeclSpace ds, XmlElement el)
 674                 {
 675                         Hashtable paramTags = new Hashtable ();
 676                         foreach (XmlElement pelem in el.SelectNodes ("param")) {
 677                                 int i;
 678                                 string xname = pelem.GetAttribute ("name");
 679                                 if (xname == "")
 680                                         continue; // really? but MS looks doing so
 681                                 if (xname != "" && mc.Parameters.GetParameterByName (xname, out i) == null)
 682                                         Report.Warning (1572, 2, mc.Location, "XML comment on '{0}' has a 'param' tag for '{1}', but there is no such parameter.", mc.Name, xname);
 683                                 else if (paramTags [xname] != null)
 684                                         Report.Warning (1571, 2, mc.Location, "XML comment on '{0}' has a duplicate param tag for '{1}'", mc.Name, xname);
 685                                 paramTags [xname] = xname;
 686                         }
 687                         Parameter [] plist = mc.Parameters.FixedParameters;
 688                         if (plist != null) {
 689                                 foreach (Parameter p in plist) {
 690                                         if (paramTags.Count > 0 && paramTags [p.Name] == null)
 691                                                 Report.Warning (1573, 4, mc.Location, "Parameter '{0}' has no matching param tag in the XML comment for '{1}' (but other parameters do)", mc.Name, p.Name);
 692                                 }
 693                         }
 694                 }
 695
 696                 // Enum
 697                 public static void GenerateEnumDocComment (Enum e, DeclSpace ds)
 698                 {
 699                         GenerateDocComment (e, ds);
 700                         foreach (string name in e.ordered_enums) {
 701                                 MemberCore mc = e.GetDefinition (name);
 702                                 GenerateDocComment (mc, e);
 703                         }
 704                 }
 705         }
 706
 707         //
 708         // Implements XML documentation generation.
 709         //
 710         public class Documentation
 711         {
 712                 public Documentation (string xml_output_filename)
 713                 {
 714                         docfilename = xml_output_filename;
 715                         XmlDocumentation = new XmlDocument ();
 716                         XmlDocumentation.PreserveWhitespace = false;
 717                 }
 718
 719                 private string docfilename;
 720
 721                 //
 722                 // Used to create element which helps well-formedness checking.
 723                 //
 724                 public XmlDocument XmlDocumentation;
 725
 726                 //
 727                 // The output for XML documentation.
 728                 //
 729                 public XmlWriter XmlCommentOutput;
 730
 731                 //
 732                 // Stores XmlDocuments that are included in XML documentation.
 733                 // Keys are included filenames, values are XmlDocuments.
 734                 //
 735                 public Hashtable StoredDocuments = new Hashtable ();
 736
 737                 //
 738                 // Stores comments on partial types (should handle uniquely).
 739                 // Keys are PartialContainers, values are comment strings
 740                 // (didn't use StringBuilder; usually we have just 2 or more).
 741                 //
 742                 public IDictionary PartialComments = new ListDictionary ();
 743
 744                 //
 745                 // Outputs XML documentation comment from tokenized comments.
 746                 //
 747                 public bool OutputDocComment (string asmfilename)
 748                 {
 749                         XmlTextWriter w = null;
 750                         try {
 751                                 w = new XmlTextWriter (docfilename, null);
 752                                 w.Indentation = 4;
 753                                 w.Formatting = Formatting.Indented;
 754                                 w.WriteStartDocument ();
 755                                 w.WriteStartElement ("doc");
 756                                 w.WriteStartElement ("assembly");
 757                                 w.WriteStartElement ("name");
 758                                 w.WriteString (Path.ChangeExtension (asmfilename, null));
 759                                 w.WriteEndElement (); // name
 760                                 w.WriteEndElement (); // assembly
 761                                 w.WriteStartElement ("members");
 762                                 XmlCommentOutput = w;
 763                                 GenerateDocComment ();
 764                                 w.WriteFullEndElement (); // members
 765                                 w.WriteEndElement ();
 766                                 w.WriteWhitespace (Environment.NewLine);
 767                                 w.WriteEndDocument ();
 768                                 return true;
 769                         } catch (Exception ex) {
 770                                 Report.Error (1569, "Error generating XML documentation file '{0}' ('{1}')", docfilename, ex.Message);
 771                                 return false;
 772                         } finally {
 773                                 if (w != null)
 774                                         w.Close ();
 775                         }
 776                 }
 777
 778                 //
 779                 // Fixes full type name of each documented types/members up.
 780                 //
 781                 public void GenerateDocComment ()
 782                 {
 783                         TypeContainer root = RootContext.Tree.Types;
 784                         if (root.Interfaces != null)
 785                                 foreach (Interface i in root.Interfaces)
 786                                         DocUtil.GenerateTypeDocComment (i, null);
 787
 788                         if (root.Types != null)
 789                                 foreach (TypeContainer tc in root.Types)
 790                                         DocUtil.GenerateTypeDocComment (tc, null);
 791
 792                         if (root.Parts != null) {
 793                                 IDictionary comments = PartialComments;
 794                                 foreach (ClassPart cp in root.Parts) {
 795                                         if (cp.DocComment == null)
 796                                                 continue;
 797                                         comments [cp] = cp;
 798                                 }
 799                         }
 800
 801                         if (root.Delegates != null)
 802                                 foreach (Delegate d in root.Delegates)
 803                                         DocUtil.GenerateDocComment (d, null);
 804
 805                         if (root.Enums != null)
 806                                 foreach (Enum e in root.Enums)
 807                                         DocUtil.GenerateEnumDocComment (e, null);
 808
 809                         IDictionary table = new ListDictionary ();
 810                         foreach (ClassPart cp in PartialComments.Keys) {
 811                                 table [cp.PartialContainer] += cp.DocComment;
 812                         }
 813                         foreach (PartialContainer pc in table.Keys) {
 814                                 pc.DocComment = table [pc] as string;
 815                                 DocUtil.GenerateDocComment (pc, null);
 816                         }
 817                 }
 818         }
 819 }