@windypro-rourou/dsh-eda 0.1.4 → 0.1.5

package/skill/references/interfaces/ISYS_HelpAudienceEntry.md

@@ -0,0 +1,92 @@
+# ISYS\_HelpAudienceEntry interface
+
+受众推荐条目（对应 `@recommendedFor` / `@notRecommendedFor` 标签）
+
+## Signature
+
+```typescript
+interface ISYS_HelpAudienceEntry
+```
+
+## Remarks
+
+如 `@recommendedFor cli - 需 force=true` 解析为 `{ role: 'cli', note: '需 force=true' }`
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[note?](./ISYS_HelpAudienceEntry.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 推荐 / 不推荐的补充说明
+
+</td></tr>
+<tr><td>
+
+[role](./ISYS_HelpAudienceEntry.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+受众 / 场景标识（如 `cli`<!-- -->、`human`<!-- -->、`plugin`<!-- -->）
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### note
+
+# ISYS\_HelpAudienceEntry.note property
+
+推荐 / 不推荐的补充说明
+
+## Signature
+
+```typescript
+note?: string;
+```
+
+### role
+
+# ISYS\_HelpAudienceEntry.role property
+
+受众 / 场景标识（如 `cli`<!-- -->、`human`<!-- -->、`plugin`<!-- -->）
+
+## Signature
+
+```typescript
+role: string;
+```

package/skill/references/interfaces/ISYS_HelpClassSummary.md

@@ -0,0 +1,205 @@
+# ISYS\_HelpClassSummary interface
+
+由 help 查询返回的类摘要
+
+## Signature
+
+```typescript
+interface ISYS_HelpClassSummary
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[deprecated?](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 类废弃说明
+
+</td></tr>
+<tr><td>
+
+[methods](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;string \| { name: string; comment?: string; visibility?: string }&gt;
+
+</td><td>
+
+方法列表
+
+</td></tr>
+<tr><td>
+
+[remarks?](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 类说明
+
+</td></tr>
+<tr><td>
+
+[title?](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 类标题
+
+</td></tr>
+<tr><td>
+
+[titles?](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+Record&lt;string, string \| undefined&gt;
+
+</td><td>
+
+_(Optional)_ 各接口标题（external 场景，键为接口名）
+
+</td></tr>
+<tr><td>
+
+[visibility?](./ISYS_HelpClassSummary.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 类可见性（`public` / `beta` / `alpha`<!-- -->）
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### deprecated
+
+# ISYS\_HelpClassSummary.deprecated property
+
+类废弃说明
+
+## Signature
+
+```typescript
+deprecated?: string;
+```
+
+### remarks
+
+# ISYS\_HelpClassSummary.remarks property
+
+类说明
+
+## Signature
+
+```typescript
+remarks?: string;
+```
+
+### title
+
+# ISYS\_HelpClassSummary.title property
+
+类标题
+
+## Signature
+
+```typescript
+title?: string;
+```
+
+### titles
+
+# ISYS\_HelpClassSummary.titles property
+
+各接口标题（external 场景，键为接口名）
+
+## Signature
+
+```typescript
+titles?: Record<string, string | undefined>;
+```
+
+### visibility
+
+# ISYS\_HelpClassSummary.visibility property
+
+类可见性（`public` / `beta` / `alpha`<!-- -->）
+
+## Signature
+
+```typescript
+visibility?: string;
+```
+
+
+---
+
+## 方法详情
+
+### methods
+
+# ISYS\_HelpClassSummary.methods property
+
+方法列表
+
+## Signature
+
+```typescript
+methods: Array<string | { name: string; comment?: string; visibility?: string }>;
+```
+
+## Remarks
+
+类场景为方法条目 `{ name, comment, visibility }`<!-- -->；external 场景为接口名 `string`<!-- -->（无注释结构）

package/skill/references/interfaces/ISYS_HelpData.md

@@ -0,0 +1,92 @@
+# ISYS\_HelpData interface
+
+lc-build 生成的 API jsonSchema（d.ts 的 JSON 形态）
+
+## Signature
+
+```typescript
+interface ISYS_HelpData
+```
+
+## Remarks
+
+结构：`$defs.{类型名}.{...jsonSchema}`<!-- -->，类的方法位于 `properties` 下
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[$defs?](./ISYS_HelpData.md)
+
+</td><td>
+
+</td><td>
+
+Record&lt;string, any&gt;
+
+</td><td>
+
+_(Optional)_ 类型定义表：类型名 -<!-- -->&gt; 类型 schema
+
+</td></tr>
+<tr><td>
+
+[$schema?](./ISYS_HelpData.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ JSON Schema 版本
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### _defs
+
+# ISYS\_HelpData.$defs property
+
+类型定义表：类型名 -<!-- -->&gt; 类型 schema
+
+## Signature
+
+```typescript
+$defs?: Record<string, any>;
+```
+
+### _schema
+
+# ISYS\_HelpData.$schema property
+
+JSON Schema 版本
+
+## Signature
+
+```typescript
+$schema?: string;
+```

package/skill/references/interfaces/ISYS_HelpMethodDetail.md

@@ -0,0 +1,310 @@
+# ISYS\_HelpMethodDetail interface
+
+Help 查询返回的方法详情
+
+## Signature
+
+```typescript
+interface ISYS_HelpMethodDetail
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[deprecated?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 方法废弃说明
+
+</td></tr>
+<tr><td>
+
+[example?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 使用示例
+
+</td></tr>
+<tr><td>
+
+[isAsync?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+boolean
+
+</td><td>
+
+_(Optional)_ 方法是否异步（返回 Promise，调用时需 `await`<!-- -->）
+
+</td></tr>
+<tr><td>
+
+[notRecommendedFor?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[ISYS\_HelpAudienceEntry](./ISYS_HelpAudienceEntry.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ 不推荐的受众 / 场景（来自 `@notRecommendedFor`<!-- -->，可多个）
+
+</td></tr>
+<tr><td>
+
+[params?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;{ name: string; type?: string; description?: string; required?: boolean; deprecated?: string; }&gt;
+
+</td><td>
+
+_(Optional)_ 入参列表
+
+</td></tr>
+<tr><td>
+
+[recommendedFor?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+Array&lt;[ISYS\_HelpAudienceEntry](./ISYS_HelpAudienceEntry.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ 推荐的受众 / 场景（来自 `@recommendedFor`<!-- -->，可多个）
+
+</td></tr>
+<tr><td>
+
+[remarks?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 方法说明
+
+</td></tr>
+<tr><td>
+
+[returns?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+\{ type?: string; description?: string \}
+
+</td><td>
+
+_(Optional)_ 返回值
+
+</td></tr>
+<tr><td>
+
+[title?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 方法标题
+
+</td></tr>
+<tr><td>
+
+[visibility?](./ISYS_HelpMethodDetail.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ 方法可见性（`public` / `beta` / `alpha`<!-- -->）
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### deprecated
+
+# ISYS\_HelpMethodDetail.deprecated property
+
+方法废弃说明
+
+## Signature
+
+```typescript
+deprecated?: string;
+```
+
+### example
+
+# ISYS\_HelpMethodDetail.example property
+
+使用示例
+
+## Signature
+
+```typescript
+example?: string;
+```
+
+### isasync
+
+# ISYS\_HelpMethodDetail.isAsync property
+
+方法是否异步（返回 Promise，调用时需 `await`<!-- -->）
+
+## Signature
+
+```typescript
+isAsync?: boolean;
+```
+
+### notrecommendedfor
+
+# ISYS\_HelpMethodDetail.notRecommendedFor property
+
+不推荐的受众 / 场景（来自 `@notRecommendedFor`<!-- -->，可多个）
+
+## Signature
+
+```typescript
+notRecommendedFor?: Array<ISYS_HelpAudienceEntry>;
+```
+
+### params
+
+# ISYS\_HelpMethodDetail.params property
+
+入参列表
+
+## Signature
+
+```typescript
+params?: Array<{
+		name: string;
+		type?: string;
+		description?: string;
+		required?: boolean;
+		deprecated?: string;
+	}>;
+```
+
+### recommendedfor
+
+# ISYS\_HelpMethodDetail.recommendedFor property
+
+推荐的受众 / 场景（来自 `@recommendedFor`<!-- -->，可多个）
+
+## Signature
+
+```typescript
+recommendedFor?: Array<ISYS_HelpAudienceEntry>;
+```
+
+### remarks
+
+# ISYS\_HelpMethodDetail.remarks property
+
+方法说明
+
+## Signature
+
+```typescript
+remarks?: string;
+```
+
+### returns
+
+# ISYS\_HelpMethodDetail.returns property
+
+返回值
+
+## Signature
+
+```typescript
+returns?: { type?: string; description?: string };
+```
+
+### title
+
+# ISYS\_HelpMethodDetail.title property
+
+方法标题
+
+## Signature
+
+```typescript
+title?: string;
+```
+
+### visibility
+
+# ISYS\_HelpMethodDetail.visibility property
+
+方法可见性（`public` / `beta` / `alpha`<!-- -->）
+
+## Signature
+
+```typescript
+visibility?: string;
+```