IndexedCommentsCache.Item Property

IndexedCommentsCacheItem Property

This read-only property returns the comments for the specified key

Namespace: SandcastleBuilder.Utils.InheritedDocumentation
Assemblies: GenerateInheritedDocs (in GenerateInheritedDocs.exe) Version: 2014.11.22.0
SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public XPathNavigator this[
	string key
] { get; }

Public ReadOnly Default Property Item ( 
	key As String
) As XPathNavigator
	Get

public:
property XPathNavigator^ default[String^ key] {
	XPathNavigator^ get (String^ key);
}

member Item : XPathNavigator with get

Parameters

key: Type: SystemString
The key for which to retrieve comments

Return Value

Type: XPathNavigator
An XPathNavigator for the comments or null if not found.

Reference

IndexedCommentsCache Class

SandcastleBuilder.Utils.InheritedDocumentation Namespace