Function parse

Exports

parse(content: string): { name: string }
Parse
Parameters
- content: string
  Raw content from the
Returns { name: string }
Object containing the referenced block name, or null if content is empty
Api Use
tag to extract reference to predefined block

Processes

Api Use
tags by extracting the name of a predefined documentation block that should be included in the current API endpoint documentation. This enables DRY (Don't Repeat Yourself) principles in API documentation.

Api Use
tag containing the block name
Example: Reference to predefined block
```
// Input: "UserObject"
// Output: { name: "UserObject" }
```
Example: Reference to error responses
```
// Input: "CommonErrors"
// Output: { name: "CommonErrors" }
```
Example: Empty content
```
// Input: "   "
// Output: null
```
Since
4.0.0

Public
- Defined in core/parsers/api_use.ts:40