ParsedJSDoc

Docflow에서 사용하는 JSDoc 템플릿을 파싱한 결과를 나타내요.

시그니처

interface ParsedJSDoc { name?: string; description?: string; category?: string; kind?: string; signature?: string; deprecated?: string; examples?: ExampleData[]; parameters?: ParameterData[]; returns?: ReturnData; throws?: ThrowsData[]; typedef?: TypedefData[]; see?: SeeData[]; version?: VersionData[] }

매개변수

• name · string
  

  문서화된 요소의 이름

• description · string
  

  요소의 설명

• category · string
  

  요소의 카테고리 분류

• kind · string
  

  선언의 종류 (function, class, interface 등)

• signature · string
  

  요소의 TypeScript 시그니처

• deprecated · string
  

  사용 중단 알림 (해당되는 경우)

• examples · ExampleData[]
  

  예제 코드의 배열

• parameters · ParameterData[]
  

  매개변수 정보의 배열

• returns · ReturnData
  

  반환값 정보

• throws · ThrowsData[]
  

  예외 정보의 배열

• typedef · TypedefData[]
  

  타입 정의의 배열

• see · SeeData[]
  

  관련 문서에 대한 참조의 배열

• version · VersionData[]
  

  버전 정보의 배열