ApiDocNamespace Type
Represents a namespace integrated with its associated documentation
Constructors
Constructor |
Description
|
Full Usage:
ApiDocNamespace(name, modifiers, substitutions, nsdocs)
Parameters:
string
modifiers : ApiDocEntity list
substitutions : Substitutions
nsdocs : ApiDocComment option
Returns: ApiDocNamespace
|
|
Instance members
Instance member |
Description
|
|
All modules in the namespace
|
Full Usage:
this.Name
Returns: string
|
The name of the namespace
|
|
The summary text for the namespace
|
Full Usage:
this.OutputFile
Parameters:
string
qualify : bool
extension : string
Returns: string
|
The name of the file generated for this entity
|
|
The substitution substitutions active for generating thist content
|
Full Usage:
this.Url
Parameters:
string
collectionName : string
qualify : bool
extension : string
Returns: string
|
The URL of the best link documentation for the item (without the http://site.io/reference)
|
Full Usage:
this.UrlBaseName
Returns: string
|
The base name for the generated file
|
Full Usage:
this.UrlHash
Returns: string
|
The hash label for the URL with the overall namespaces file
|