diff --git a/cocos/core/components/ui-coodinate-tracker-component.ts b/cocos/core/components/ui-coodinate-tracker-component.ts index 327cbfbb31..5e1a228ccd 100644 --- a/cocos/core/components/ui-coodinate-tracker-component.ts +++ b/cocos/core/components/ui-coodinate-tracker-component.ts @@ -24,6 +24,10 @@ THE SOFTWARE. */ +/** + * @category component + */ + import { Component } from './component'; import { EventHandler } from './component-event-handler'; import { ccclass, property, menu, executionOrder } from '../data/class-decorator'; diff --git a/cocos/core/platform/SubContextView.ts b/cocos/core/platform/SubContextView.ts index 632f82465a..66275fda61 100644 --- a/cocos/core/platform/SubContextView.ts +++ b/cocos/core/platform/SubContextView.ts @@ -23,6 +23,10 @@ THE SOFTWARE. */ +/** + * @category component + */ + import { Component } from '../components/component'; import { property, ccclass, menu, executionOrder } from '../data/class-decorator'; import { view } from './view'; diff --git a/cocos/core/platform/debug.ts b/cocos/core/platform/debug.ts index 7f32ea49fe..b6d5190bcb 100644 --- a/cocos/core/platform/debug.ts +++ b/cocos/core/platform/debug.ts @@ -22,6 +22,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/** + * @category core + */ // @ts-ignore import debugInfos from '../../../DebugInfos'; diff --git a/cocos/core/platform/event-manager/deprecated.ts b/cocos/core/platform/event-manager/deprecated.ts index fda34c3ce9..d329d485f4 100644 --- a/cocos/core/platform/event-manager/deprecated.ts +++ b/cocos/core/platform/event-manager/deprecated.ts @@ -1,3 +1,7 @@ +/** + * @hidden + */ + import { replaceProperty } from '../../utils'; import { SystemEventType } from './event-enum'; diff --git a/cocos/core/platform/index.ts b/cocos/core/platform/index.ts index 5ffe72a3ec..285205af5a 100644 --- a/cocos/core/platform/index.ts +++ b/cocos/core/platform/index.ts @@ -23,6 +23,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/** + * @hidden + */ export * from './sys'; export * from './macro'; diff --git a/cocos/core/platform/macro.ts b/cocos/core/platform/macro.ts index b8cfacfcf1..3c5d7ca669 100644 --- a/cocos/core/platform/macro.ts +++ b/cocos/core/platform/macro.ts @@ -25,6 +25,10 @@ THE SOFTWARE. */ +/** + * @category core + */ + import { Vec2 } from '../math'; /** diff --git a/cocos/core/platform/screen.ts b/cocos/core/platform/screen.ts index 1b9d587d54..5e88c087ce 100644 --- a/cocos/core/platform/screen.ts +++ b/cocos/core/platform/screen.ts @@ -24,6 +24,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/** + * @category core + */ // tslint:disable diff --git a/cocos/core/platform/sys.ts b/cocos/core/platform/sys.ts index 92ae1c0cf4..8f4f176309 100644 --- a/cocos/core/platform/sys.ts +++ b/cocos/core/platform/sys.ts @@ -23,6 +23,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/** + * @category core + */ // tslint:disable diff --git a/cocos/core/platform/view.ts b/cocos/core/platform/view.ts index 8eaec12f39..e51a4411ad 100644 --- a/cocos/core/platform/view.ts +++ b/cocos/core/platform/view.ts @@ -25,6 +25,10 @@ THE SOFTWARE. */ +/** + * @category core + */ + import '../data/class'; import { EventTarget } from '../event/event-target'; import '../game'; diff --git a/cocos/core/platform/visible-rect.ts b/cocos/core/platform/visible-rect.ts index 4d3a96c4c9..2314ec881d 100644 --- a/cocos/core/platform/visible-rect.ts +++ b/cocos/core/platform/visible-rect.ts @@ -24,6 +24,10 @@ THE SOFTWARE. */ +/** + * @hidden + */ + import { Rect } from '../math'; /** diff --git a/cocos/core/renderer/ui/ui-draw-batch.ts b/cocos/core/renderer/ui/ui-draw-batch.ts index 90bb4f28a1..075bfc91c1 100644 --- a/cocos/core/renderer/ui/ui-draw-batch.ts +++ b/cocos/core/renderer/ui/ui-draw-batch.ts @@ -1,3 +1,7 @@ +/** + * @hidden + */ + import { UI } from "./ui"; import { Camera } from "../scene/camera"; import { MeshBuffer } from "../../../ui"; diff --git a/cocos/ui/assembler/sprite/tiled.ts b/cocos/ui/assembler/sprite/tiled.ts index d4fa0f489b..66d4fb0da8 100644 --- a/cocos/ui/assembler/sprite/tiled.ts +++ b/cocos/ui/assembler/sprite/tiled.ts @@ -23,6 +23,10 @@ THE SOFTWARE. */ +/** + * @hidden + */ + import { Mat4, Vec3, Color } from '../../../core/math'; import { RenderData, IRenderData } from '../../../core/renderer/ui/render-data'; import { UI } from '../../../core/renderer/ui/ui'; diff --git a/cocos/ui/components/webview/webView-component.ts b/cocos/ui/components/webview/webView-component.ts index 34fadee10e..056fd73859 100644 --- a/cocos/ui/components/webview/webView-component.ts +++ b/cocos/ui/components/webview/webView-component.ts @@ -24,6 +24,10 @@ THE SOFTWARE. */ +/** + * @category ui + */ + import { EventHandler } from '../../../core/components/component-event-handler'; import { ccclass, executionOrder, menu, property } from '../../../core/data/class-decorator'; import { UIComponent } from '../../../core/components/ui-base/ui-component'; diff --git a/cocos/ui/components/webview/webview-impl.ts b/cocos/ui/components/webview/webview-impl.ts index 3a2e97dc06..a1f895b145 100644 --- a/cocos/ui/components/webview/webview-impl.ts +++ b/cocos/ui/components/webview/webview-impl.ts @@ -23,6 +23,10 @@ THE SOFTWARE. */ +/** + * @hidden + */ + import { ccclass } from '../../../core/data/class-decorator'; import sys from '../../../core/platform/sys'; import { misc } from '../../../core/utils'; diff --git a/gulp/util/api-docs-build.js b/gulp/util/api-docs-build.js index 652fafdff4..0a194aaaed 100644 --- a/gulp/util/api-docs-build.js +++ b/gulp/util/api-docs-build.js @@ -12,7 +12,7 @@ program const mode = 'modules'; const docsName = 'Creator-3d-API'; -const exclude = '"**/cocos/**/+(webgl|webgl2|utils|builtin|renderer|scene|models|misc|ammo|shapes|constraint|cannon|graphics|webview|platform|profiler)/*.ts"'; +const exclude = '"**/cocos/**/+(webgl|webgl2|utils|builtin|renderer|scene|models|misc|ammo|shapes|constraint|cannon|graphics|profiler)/*.ts"'; const readme = 'none'; //const exclude = '"**/cocos/**/index.ts"';