Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Configuration/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Type for Docflow configuration files. Includes project settings, command setting
type Config = z.infer<typeof configSchema>;
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Generator/GeneratedDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ interface GeneratedDoc {
}
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Generator/GeneratorConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ interface GeneratorConfig { name: string; projectRoot: string; labels?: {
}; signatureLanguage?: string }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Generator/MarkdownDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Structure representing a complete Markdown document with optional frontmatter an
interface MarkdownDocument { frontmatter?: Record<string, unknown>; sections: MarkdownSection[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Generator/MarkdownGenerator.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface MarkdownGenerator { generate(jsDocData: ParsedJSDoc, sourcePath?: stri
): GeneratedDoc }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Generator/MarkdownSection.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Interface representing a section of a Markdown document.
interface MarkdownSection { type: MarkdownSectionType; content: string }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Manifest/SidebarItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents a sidebar navigation item for the documentation site. Can be a link o
interface SidebarItem { text: string; link?: string; items?: SidebarItem[]; collapsed?: boolean }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ExampleData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @example tags in JSDoc.
interface ExampleData { title?: string; code: string; language?: string }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ExportDeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type ExportDeclaration = {
};
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ParameterData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @param tags in JSDoc.
interface ParameterData { name: string; type: string; description: string; required: boolean; defaultValue?: string; nested?: ParameterData[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ParsedJSDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of JSDoc templates used in Docflow.
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[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ReturnData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @returns tags in JSDoc. Used to describe return
interface ReturnData { type: string; name?: string; description: string; properties?: PropertyData[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/SeeData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @see tags in JSDoc. Used to provide references t
interface SeeData { reference: string; description?: string }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/TargetWithJSDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ interface TargetWithJSDoc extends ExportDeclaration {
}
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/ThrowsData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @throws tags in JSDoc. Used to describe exceptio
interface ThrowsData { type: string; name?: string; description: string }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/TypedefData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @typedef tags in JSDoc. Used to define custom ty
interface TypedefData { name: string; type: string; description: string; properties: PropertyData[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Parser/VersionData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Represents the parsed result of @version tags in JSDoc. Used to display version
interface VersionData { version: string; description: string; platforms?: string[] }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Plugin/Plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface Plugin { name: string; hooks: {
} }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/cli/Plugin/PluginContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Context information passed during plugin execution. Includes workspace path and
interface PluginContext { workspacePath?: string; config?: Config }
```

### Parameters
### Properties

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Configuration/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Docflow의 μ„€μ • νƒ€μž…μ΄μ—μš”. ν”„λ‘œμ νŠΈ μ„€μ •, λͺ…λ Ήμ–΄ μ„€μ •, ν”ŒλŸ¬
type Config = z.infer<typeof configSchema>;
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Generator/GeneratedDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sourcePath: "packages/cli/src/core/types/generator.types.ts"
interface GeneratedDoc { filePath: StandardizedFilePath; content: string; relativePath: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Generator/GeneratorConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ interface GeneratorConfig { name: string; projectRoot: string; labels?: {
}; signatureLanguage?: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Generator/MarkdownDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sourcePath: "packages/cli/src/core/types/generator.types.ts"
interface MarkdownDocument { frontmatter?: Record<string, unknown>; sections: MarkdownSection[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Generator/MarkdownGenerator.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface MarkdownGenerator { generate(jsDocData: ParsedJSDoc, sourcePath?: stri
): GeneratedDoc }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Generator/MarkdownSection.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Markdown λ¬Έμ„œμ˜ μ„Ήμ…˜μ„ λ‚˜νƒ€λ‚΄λŠ” μΈν„°νŽ˜μ΄μŠ€μ—μš”.
interface MarkdownSection { type: MarkdownSectionType; content: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Manifest/SidebarItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sourcePath: "packages/cli/src/commands/build/manifest/manifest.ts"
interface SidebarItem { text: string; link?: string; items?: SidebarItem[]; collapsed?: boolean }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ExampleData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @example νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”.
interface ExampleData { title?: string; code: string; language?: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ExportDeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type ExportDeclaration = {
};
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ParameterData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @param νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”.
interface ParameterData { name: string; type: string; description: string; required: boolean; defaultValue?: string; nested?: ParameterData[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ParsedJSDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ReturnData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @returns νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”. ν•¨μˆ˜μ˜ 반
interface ReturnData { type: string; name?: string; description: string; properties?: PropertyData[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/SeeData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @see νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”. μ™ΈλΆ€ λ¬Έμ„œλ‚˜
interface SeeData { reference: string; description?: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/TargetWithJSDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ interface TargetWithJSDoc extends ExportDeclaration {
}
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/ThrowsData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @throws νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”. ν•¨μˆ˜μ—μ„œ 발
interface ThrowsData { type: string; name?: string; description: string }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/TypedefData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @typedef νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”. μ‚¬μš©μž μ •
interface TypedefData { name: string; type: string; description: string; properties: PropertyData[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Parser/VersionData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JSDocμ—μ„œ @version νƒœκ·Έλ₯Ό νŒŒμ‹±ν•œ κ²°κ³Όλ₯Ό λ‚˜νƒ€λ‚΄μš”. 버전 정보
interface VersionData { version: string; description: string; platforms?: string[] }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Plugin/Plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface Plugin { name: string; hooks: {
} }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/cli/Plugin/PluginContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sourcePath: "packages/cli/src/plugins/types/plugin.types.ts"
interface PluginContext { workspacePath?: string; config?: Config }
```

### λ§€κ°œλ³€μˆ˜
### 속성

<ul class="post-parameters-ul">
<li class="post-parameters-li post-parameters-li-root">
Expand Down