ApiReferenceContentService

class

Namespace: MyLittleContentEngine.Services.Content

Content service for generating API reference documentation from .NET assemblies using Roslyn

Declaration

public class ApiReferenceContentService

Inheritance

object → ApiReferenceContentService

Implements

  • MyLittleContentEngine.Services.Content.IContentService
  • System.IDisposable

Methods

Dispose

method
public void Dispose()
Returns: void

GetContentToCopyAsync

method
public Task<ImmutableList<ContentToCopy>> GetContentToCopyAsync()
Returns: Task<ImmutableList<ContentToCopy>>

GetCrossReferencesAsync

method
public Task<ImmutableList<CrossReference>> GetCrossReferencesAsync()
Returns: Task<ImmutableList<CrossReference>>

GetMembersAsync

method
public Task<ImmutableList<ApiMember>> GetMembersAsync()
Gets all API members for display purposes
Returns: Task<ImmutableList<ApiMember>>

GetMembersByMicrosoftStyleIdAsync

method
public Task<ImmutableList<ApiMember>> GetMembersByMicrosoftStyleIdAsync(string microsoftStyleId)
Gets members by Microsoft-style identifier (can return multiple results for overloads)
Returns: Task<ImmutableList<ApiMember>>
microsoftStyleId string

GetNamespaceByMicrosoftStyleIdAsync

method
public Task<ApiNamespace?> GetNamespaceByMicrosoftStyleIdAsync(string microsoftStyleId)
Gets a specific namespace by Microsoft-style identifier
Returns: Task<ApiNamespace?>
microsoftStyleId string

GetNamespaceByNameAsync

method
public Task<ApiNamespace?> GetNamespaceByNameAsync(string name)
Gets a specific namespace by name
Returns: Task<ApiNamespace?>
name string

GetNamespaceByXmlDocIdAsync

method
public Task<ApiNamespace?> GetNamespaceByXmlDocIdAsync(string xmlDocId)
Gets a specific namespace by XML Doc ID
Returns: Task<ApiNamespace?>
xmlDocId string

GetNamespacesAsync

method
public Task<ImmutableList<ApiNamespace>> GetNamespacesAsync()
Gets all API namespaces for display purposes
Returns: Task<ImmutableList<ApiNamespace>>

GetPagesToGenerateAsync

method
public Task<ImmutableList<PageToGenerate>> GetPagesToGenerateAsync()
Returns: Task<ImmutableList<PageToGenerate>>

GetTocEntriesToGenerateAsync

method
public Task<ImmutableList<PageToGenerate>> GetTocEntriesToGenerateAsync()
Returns: Task<ImmutableList<PageToGenerate>>

GetTypeByMicrosoftStyleIdAsync

method
public Task<ApiType?> GetTypeByMicrosoftStyleIdAsync(string microsoftStyleId)
Gets a specific type by Microsoft-style identifier
Returns: Task<ApiType?>
microsoftStyleId string

GetTypeByNameAsync

method
public Task<ApiType?> GetTypeByNameAsync(string namespaceName, string typeName)
Gets a specific type by namespace and name
Returns: Task<ApiType?>
namespaceName string
typeName string

GetTypeByXmlDocIdAsync

method
public Task<ApiType?> GetTypeByXmlDocIdAsync(string xmlDocId)
Gets a specific type by XML Doc ID
Returns: Task<ApiType?>
xmlDocId string

GetTypesAsync

method
public Task<ImmutableList<ApiType>> GetTypesAsync()
Gets all API types for display purposes
Returns: Task<ImmutableList<ApiType>>