Function aiDocumentCodeInstruction

aiDocumentCodeInstruction(language?: string, framework?: string, inDetail?: boolean, examples?: string): string
Generates instruction for AI to document in JSDoc the provided source code.

Returns
Instruction to describe code for the provided source code.
Parameters
- Optional language: string
  
  The programming language, e.g. TypeScript. If not provided, defaults to TypeScript.
- Optional framework: string
  
  The testing framework, e.g. JSDoc. If not provided, defaults to JSDoc.
- Optional inDetail: boolean
  
  Detailed or short mode. If not provided, defaults to false.
- Optional examples: string
  
  The examples. If not provided, defaults to "".
Returns string
- Defined in fi/hg/core/openai/instructions/aiDocumentCodeInstruction.ts:49