| NamespaceSummaryItemCollectionAdd Method (String, Boolean, Boolean, String) |
Add a new item to the collection
Namespace: SandcastleBuilder.UtilsAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax public NamespaceSummaryItem Add(
string name,
bool isGroup,
bool isDocumented,
string summary
)
Public Function Add (
name As String,
isGroup As Boolean,
isDocumented As Boolean,
summary As String
) As NamespaceSummaryItem
public:
NamespaceSummaryItem^ Add(
String^ name,
bool isGroup,
bool isDocumented,
String^ summary
)
member Add :
name : string *
isGroup : bool *
isDocumented : bool *
summary : string -> NamespaceSummaryItem
Parameters
- name
- Type: SystemString
The namespace name - isGroup
- Type: SystemBoolean
True if this is a grouping namespace, false if this is normal namespace - isDocumented
- Type: SystemBoolean
True for documented, false for not documented - summary
- Type: SystemString
The summary text
Return Value
Type:
NamespaceSummaryItemThe
NamespaceSummaryItem added to the project. If the namespace already
exists in the collection, the existing item is returned.
Remarks The
NamespaceSummaryItem constructor is internal so that we control creation
of the items and can associate them with the project.
See Also