首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >为什么typedoc忽略我的接口声明?

为什么typedoc忽略我的接口声明?
EN

Stack Overflow用户
提问于 2021-06-01 03:00:23
回答 1查看 102关注 0票数 3
代码语言:javascript
复制
type S=string|undefined;
declare global {
    export interface String {
        /**
         * returns string between borders
         * @param   borderA - left border
         * @param   borderB - right border
         * @param aIsFirst - true if borderA is first, false if is last
         * @param bIsFirst - true if borderB is first, false if is last
         */
        between(borderA:S, borderB:S, aIsFirst:boolean, bIsFirst:boolean):S;
    }
}

typedoc命令:typedoc --out ./documentation/ src/

它生成的文件夹带有超文本标记语言,取自README.md,但在那里找不到我的界面的痕迹……

EN

回答 1

Stack Overflow用户

发布于 2021-12-03 11:32:17

TypeDoc将只记录由您的一个入口点导出的内容。如果您导出Foo而不是IFoo,您将收到一条错误消息,指出它已使用“但未包含在文档中”……

请参阅https://github.com/TypeStrong/typedoc/issues/1739

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/67779048

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档