DreamineWeb.ViewModels.DocViewModel 클래스 참조

더 자세히 ...

DreamineWeb.ViewModels.DocViewModel에 대한 상속 다이어그램 :

DreamineWeb.ViewModels.DocViewModel에 대한 협력 다이어그램:

Public 멤버 함수
	DocViewModel (ILibraryStore store)
async Task	LoadAsync (string libraryId)
void	RefreshReadme ()

속성
LibraryInfo?	Library [get, private set]
List< DocMember >	Members = [] [get, private set]
bool	IsKorean = true [get, set]
string?	ReadmeHtml [get, private set]
string?	MermaidDiagram [get, private set]
bool	HasDiagram [get, private set]
string	DiagramUrl = string.Empty [get, private set]
IEnumerable< DocMember >	Types [get]
IEnumerable< IGrouping< string?, DocMember > >	MembersByType [get]

Private 멤버 함수
void	LoadReadme (string docDir)

Private 속성
readonly ILibraryStore	_store
readonly string	_xmlDocRoot

정적 Private 속성
static readonly MarkdownPipeline	_pipeline

상세한 설명

Doc View Model 기능과 관련 상태를 캡슐화합니다.

DocViewModel.cs 파일의 17 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

DocViewModel()

DreamineWeb.ViewModels.DocViewModel.DocViewModel ( ILibraryStore store )

inline

지정한 설정으로 DocViewModel 클래스의 새 인스턴스를 초기화합니다.

매개변수

store

store에 사용할 ILibraryStore 값입니다.

DocViewModel.cs 파일의 158 번째 라인에서 정의되었습니다.

    {
        _store = store;
        _xmlDocRoot = Path.Combine(AppContext.BaseDirectory, "wwwroot", "xmldocs");
    }

다음을 참조함 : _store, _xmlDocRoot.

멤버 함수 문서화

LoadAsync()

async Task DreamineWeb.ViewModels.DocViewModel.LoadAsync ( string libraryId )

inline

Async 데이터를 불러옵니다.

매개변수

libraryId

library Id에 사용할 string 값입니다.

반환값

Load Async 작업에서 생성한 Task 결과입니다.

DocViewModel.cs 파일의 188 번째 라인에서 정의되었습니다.

    {
        Library = await _store.GetAsync(libraryId);
        Members = [];
        ReadmeHtml = null;
        MermaidDiagram = null;
        HasDiagram = false;
 
        if (Library is null) return;
 
        var docDir = Path.Combine(_xmlDocRoot, Library.Name);
 
        // XML API 문서
        var xmlPath = Path.Combine(docDir, $"{Library.Name}.xml");
        if (File.Exists(xmlPath))
            Members = XmlDocParser.Parse(xmlPath);
        else if (!string.IsNullOrEmpty(Library.XmlDocPath) && File.Exists(Library.XmlDocPath))
            Members = XmlDocParser.Parse(Library.XmlDocPath);
 
        // README
        LoadReadme(docDir);
 
        // Mermaid 다이어그램 (우선)
        var mermaidPath = Path.Combine(docDir, "diagram.mermaid");
        if (File.Exists(mermaidPath))
        {
            MermaidDiagram = File.ReadAllText(mermaidPath).Trim();
            HasDiagram = true;
        }
        else
        {
            // SVG fallback
            var svgPath = Path.Combine(docDir, "diagram.svg");
            if (File.Exists(svgPath))
            {
                HasDiagram = true;
                DiagramUrl = $"/xmldocs/{Library.Name}/diagram.svg";
            }
        }
    }

다음을 참조함 : _store, _xmlDocRoot, DiagramUrl, HasDiagram, Library, LoadReadme(), Members, MermaidDiagram, DreamineWeb.Services.XmlDocParser.Parse(), ReadmeHtml.

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

LoadReadme()

void DreamineWeb.ViewModels.DocViewModel.LoadReadme ( string docDir )

inlineprivate

Readme 데이터를 불러옵니다.

매개변수

docDir

doc Dir에 사용할 string 값입니다.

DocViewModel.cs 파일의 259 번째 라인에서 정의되었습니다.

    {
        string? mdPath = null;
 
        if (IsKorean)
        {
            var ko1 = Path.Combine(docDir, "README_KO.md");
            var ko2 = Path.Combine(docDir, "README_ko.md");
            if (File.Exists(ko1)) mdPath = ko1;
            else if (File.Exists(ko2)) mdPath = ko2;
        }
 
        if (mdPath is null)
        {
            var en = Path.Combine(docDir, "README.md");
            if (File.Exists(en)) mdPath = en;
        }
 
        ReadmeHtml = mdPath is not null
            ? Markdown.ToHtml(File.ReadAllText(mdPath), _pipeline)
            : null;
    }

다음을 참조함 : _pipeline, IsKorean, ReadmeHtml.

다음에 의해서 참조됨 : LoadAsync(), RefreshReadme().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

RefreshReadme()

void DreamineWeb.ViewModels.DocViewModel.RefreshReadme ( )

inline

Refresh Readme 작업을 수행합니다.

DocViewModel.cs 파일의 237 번째 라인에서 정의되었습니다.

    {
        if (Library is not null)
            LoadReadme(Path.Combine(_xmlDocRoot, Library.Name));
    }

다음을 참조함 : _xmlDocRoot, Library, LoadReadme().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

멤버 데이터 문서화

_pipeline

readonly MarkdownPipeline DreamineWeb.ViewModels.DocViewModel._pipeline

staticprivate

초기값:

                                               =
new MarkdownPipelineBuilder().UseAdvancedExtensions().Build()

pipeline 값을 보관합니다.

DocViewModel.cs 파일의 46 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : LoadReadme().

_store

readonly ILibraryStore DreamineWeb.ViewModels.DocViewModel._store

private

store 값을 보관합니다.

DocViewModel.cs 파일의 27 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : DocViewModel(), LoadAsync().

_xmlDocRoot

readonly string DreamineWeb.ViewModels.DocViewModel._xmlDocRoot

private

xml Doc Root 값을 보관합니다.

DocViewModel.cs 파일의 36 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : DocViewModel(), LoadAsync(), RefreshReadme().

속성 문서화

DiagramUrl

string DreamineWeb.ViewModels.DocViewModel.DiagramUrl = string.Empty

getprivate set

wwwroot 기준 상대 URL (SVG fallback용)

DocViewModel.cs 파일의 116 번째 라인에서 정의되었습니다.

{ get; private set; } = string.Empty;

다음에 의해서 참조됨 : LoadAsync().

HasDiagram

bool DreamineWeb.ViewModels.DocViewModel.HasDiagram

getprivate set

Has Diagram 값을 가져오거나 설정합니다.

DocViewModel.cs 파일의 106 번째 라인에서 정의되었습니다.

{ get; private set; }

다음에 의해서 참조됨 : LoadAsync().

IsKorean

bool DreamineWeb.ViewModels.DocViewModel.IsKorean = true

getset

Is Korean 값을 가져오거나 설정합니다.

DocViewModel.cs 파일의 76 번째 라인에서 정의되었습니다.

{ get; set; } = true;

다음에 의해서 참조됨 : LoadReadme().

Library

LibraryInfo? DreamineWeb.ViewModels.DocViewModel.Library

getprivate set

Library 값을 가져오거나 설정합니다.

DocViewModel.cs 파일의 57 번째 라인에서 정의되었습니다.

{ get; private set; }

다음에 의해서 참조됨 : LoadAsync(), RefreshReadme().

Members

List<DocMember> DreamineWeb.ViewModels.DocViewModel.Members = []

getprivate set

Members 값을 가져오거나 설정합니다.

DocViewModel.cs 파일의 66 번째 라인에서 정의되었습니다.

{ get; private set; } = [];

다음에 의해서 참조됨 : LoadAsync().

MembersByType

IEnumerable<IGrouping<string?, DocMember> > DreamineWeb.ViewModels.DocViewModel.MembersByType

get

Members By Type 값을 가져옵니다.

DocViewModel.cs 파일의 137 번째 라인에서 정의되었습니다.

MermaidDiagram

string? DreamineWeb.ViewModels.DocViewModel.MermaidDiagram

getprivate set

Mermaid 다이어그램 원본 텍스트. null이면 다이어그램 없음.

DocViewModel.cs 파일의 96 번째 라인에서 정의되었습니다.

{ get; private set; }

다음에 의해서 참조됨 : LoadAsync().

ReadmeHtml

string? DreamineWeb.ViewModels.DocViewModel.ReadmeHtml

getprivate set

마크다운 → HTML 변환 결과. null이면 README 없음.

DocViewModel.cs 파일의 86 번째 라인에서 정의되었습니다.

{ get; private set; }

다음에 의해서 참조됨 : LoadAsync(), LoadReadme().

Types

IEnumerable<DocMember> DreamineWeb.ViewModels.DocViewModel.Types

get

Types 값을 가져옵니다.

DocViewModel.cs 파일의 126 번째 라인에서 정의되었습니다.

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• DocViewModel.cs