1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
// Copyright (c) 2010-2013 AlphaSierraPapa for the SharpDevelop Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System;
using ICSharpCode.NRefactory.Editor;
using ICSharpCode.NRefactory.TypeSystem;
namespace ICSharpCode.NRefactory.Documentation
{
/// <summary>
/// Represents a documentation comment.
/// </summary>
public class DocumentationComment
{
ITextSource xml;
protected readonly ITypeResolveContext context;
/// <summary>
/// Gets the XML code for this documentation comment.
/// </summary>
public ITextSource Xml {
get { return xml; }
}
/// <summary>
/// Creates a new DocumentationComment.
/// </summary>
/// <param name="xml">The XML text.</param>
/// <param name="context">Context for resolving cref attributes.</param>
public DocumentationComment(ITextSource xml, ITypeResolveContext context)
{
if (xml == null)
throw new ArgumentNullException("xml");
if (context == null)
throw new ArgumentNullException("context");
this.xml = xml;
this.context = context;
}
/// <summary>
/// Creates a new DocumentationComment.
/// </summary>
/// <param name="xml">The XML text.</param>
/// <param name="context">Context for resolving cref attributes.</param>
public DocumentationComment(string xml, ITypeResolveContext context)
{
if (xml == null)
throw new ArgumentNullException("xml");
if (context == null)
throw new ArgumentNullException("context");
this.xml = new StringTextSource(xml);
this.context = context;
}
/// <summary>
/// Resolves the given cref value to an entity.
/// Returns null if the entity is not found, or if the cref attribute is syntactically invalid.
/// </summary>
public virtual IEntity ResolveCref(string cref)
{
try {
return IdStringProvider.FindEntity(cref, context);
} catch (ReflectionNameParseException) {
return null;
}
}
public override string ToString ()
{
return Xml.Text;
}
public static implicit operator string (DocumentationComment documentationComment)
{
if (documentationComment != null)
return documentationComment.ToString ();
return null;
}
}
}
|