ParsedJSDoc

Represents the parsed result of JSDoc templates used in Docflow.

Signature

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

Properties

• name · string
  

  Name of the documented element

• description · string
  

  Description of the element

• category · string
  

  Category classification of the element

• kind · string
  

  Type of declaration (function, class, interface, etc.)

• signature · string
  

  TypeScript signature of the element

• deprecated · string
  

  Deprecation notice (if applicable)

• examples · ExampleData[]
  

  Array of example code

• parameters · ParameterData[]
  

  Array of parameter information

• properties · PropertyData[]
  

  Array of property information for interface/type declarations

• returns · ReturnData
  

  Return value information

• throws · ThrowsData[]
  

  Array of exception information

• typedef · TypedefData[]
  

  Array of type definitions

• see · SeeData[]
  

  Array of references to related documentation

• version · VersionData[]
  

  Array of version information