ProjectContext

CloudNimble.DotNetDocs.Core.ProjectContext

// Default (public members only)
var context = new ProjectContext("ref1.dll", "ref2.dll") { ConceptualPath = "conceptual" };

// Include public and internal members
var context = new ProjectContext([Accessibility.Public, Accessibility.Internal], "ref1.dll", "ref2.dll");

var model = await manager.DocumentAsync("MyLib.dll", "MyLib.xml", context);

public ProjectContext()

public ProjectContext(System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility> includedMembers, params string[] references)

public Object()

public string ApiReferencePath { get; set; }

public bool ConceptualDocsEnabled { get; set; }

public string ConceptualPath { get; set; }

public bool CreateExternalTypeReferences { get; set; }

public System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocumentationReference> DocumentationReferences { get; set; }

var context = new ProjectContext
{
    DocumentationReferences = new List<DocumentationReference>
    {
        new DocumentationReference
        {
            ProjectPath = @"C:\repos\auth-service\docs\AuthService.docsproj",
            DocumentationRoot = @"C:\repos\auth-service\docs",
            DestinationPath = "services/auth",
            DocumentationType = "Mintlify",
            IntegrationType = "Tabs"
        }
    }
};

public string DocumentationRootPath { get; set; }

public System.Collections.Generic.HashSet<string> ExcludedTypes { get; set; }

public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; set; }

public bool HasMintlifyTemplate { get; set; }

public System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility> IncludedMembers { get; set; }

public bool IncludeFields { get; set; }

public bool IncludeSystemObjectInheritance { get; set; }

public System.Collections.Generic.List<string> References { get; set; }

public bool ShowPlaceholders { get; set; }

public void EnsureOutputDirectoryStructure(CloudNimble.DotNetDocs.Core.DocAssembly assemblyModel, string outputPath)

public virtual bool Equals(object obj)

public static bool Equals(object objA, object objB)

public string GetFullConceptualPath()

// When ConceptualPath is absolute
context.ConceptualPath = "C:\\Docs\\conceptual";
var path = context.GetFullConceptualPath(); // Returns "C:\Docs\conceptual"

// When ConceptualPath is relative
context.DocumentationRootPath = "C:\\Docs";
context.ConceptualPath = "conceptual";
var path = context.GetFullConceptualPath(); // Returns "C:\Docs\conceptual"

public virtual int GetHashCode()

public string GetNamespaceFolderPath(string namespaceName)

public string GetSafeNamespaceName(Microsoft.CodeAnalysis.INamespaceSymbol namespaceSymbol)

public System.Type GetType()

public string GetTypeFilePath(string fullyQualifiedTypeName, string extension)

public bool IsTypeExcluded(string fullyQualifiedTypeName)

protected internal object MemberwiseClone()

public static bool ReferenceEquals(object objA, object objB)

public virtual string ToString()