Function getDocumentationForType

getDocumentationForType(
    name: string,
    hierarchy: TypeElementInSource[],
    prefix?: string,
    filter?: GetDocumentationForTypeFilters,
): string
Retrieve documentation comments for a type. If you create a wiki, please refer to the functions provided by the GeneralWikiContext.
Parameters
- name: string
  The name of the type, e.g. MyType, may include a container, e.g.,MyContainer::MyType (this works with function nestings too) Use ::: if you want to access a scoped function, but the name should be displayed without the scope
- hierarchy: TypeElementInSource[]
  The hierarchy of types to search in
- prefix: string = ''
  A prefix to add to each line of the documentation
- Optionalfilter: GetDocumentationForTypeFilters
  Optional filters for retrieving the documentation
Returns string
- Defined in src/documentation/doc-util/doc-types.ts:744