docs(core): hide private fields in docs

This commit is contained in:
Isaac Mann 2023-09-21 15:32:57 -04:00 committed by Juri Strumpflohner
parent a49a84e753
commit 76bc58d407
3 changed files with 1 additions and 76 deletions

View File

@ -15,8 +15,6 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
### Properties ### Properties
- [graph](../../devkit/documents/ProjectGraphBuilder#graph): ProjectGraph - [graph](../../devkit/documents/ProjectGraphBuilder#graph): ProjectGraph
- [nonProjectFiles](../../devkit/documents/ProjectGraphBuilder#nonprojectfiles): FileData[]
- [projectFileMap](../../devkit/documents/ProjectGraphBuilder#projectfilemap): ProjectFileMap
- [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges): Object - [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges): Object
### Methods ### Methods
@ -28,11 +26,8 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
- [addImplicitDependency](../../devkit/documents/ProjectGraphBuilder#addimplicitdependency) - [addImplicitDependency](../../devkit/documents/ProjectGraphBuilder#addimplicitdependency)
- [addNode](../../devkit/documents/ProjectGraphBuilder#addnode) - [addNode](../../devkit/documents/ProjectGraphBuilder#addnode)
- [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency) - [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency)
- [calculateAlreadySetTargetDeps](../../devkit/documents/ProjectGraphBuilder#calculatealreadysettargetdeps)
- [calculateTargetDepsFromFiles](../../devkit/documents/ProjectGraphBuilder#calculatetargetdepsfromfiles)
- [getUpdatedProjectGraph](../../devkit/documents/ProjectGraphBuilder#getupdatedprojectgraph) - [getUpdatedProjectGraph](../../devkit/documents/ProjectGraphBuilder#getupdatedprojectgraph)
- [mergeProjectGraph](../../devkit/documents/ProjectGraphBuilder#mergeprojectgraph) - [mergeProjectGraph](../../devkit/documents/ProjectGraphBuilder#mergeprojectgraph)
- [removeDependenciesWithNode](../../devkit/documents/ProjectGraphBuilder#removedependencieswithnode)
- [removeDependency](../../devkit/documents/ProjectGraphBuilder#removedependency) - [removeDependency](../../devkit/documents/ProjectGraphBuilder#removedependency)
- [removeNode](../../devkit/documents/ProjectGraphBuilder#removenode) - [removeNode](../../devkit/documents/ProjectGraphBuilder#removenode)
- [setVersion](../../devkit/documents/ProjectGraphBuilder#setversion) - [setVersion](../../devkit/documents/ProjectGraphBuilder#setversion)
@ -59,18 +54,6 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
--- ---
### nonProjectFiles
`Private` `Readonly` **nonProjectFiles**: [`FileData`](../../devkit/documents/FileData)[]
---
### projectFileMap
`Private` `Readonly` **projectFileMap**: [`ProjectFileMap`](../../devkit/documents/ProjectFileMap)
---
### removedEdges ### removedEdges
`Readonly` **removedEdges**: `Object` = `{}` `Readonly` **removedEdges**: `Object` = `{}`
@ -219,38 +202,6 @@ Adds static dependency from source project to target project
--- ---
### calculateAlreadySetTargetDeps
`Private` **calculateAlreadySetTargetDeps**(`sourceProject`): `Map`<`string`, `Map`<`string`, [`ProjectGraphDependency`](../../devkit/documents/ProjectGraphDependency)\>\>
#### Parameters
| Name | Type |
| :-------------- | :------- |
| `sourceProject` | `string` |
#### Returns
`Map`<`string`, `Map`<`string`, [`ProjectGraphDependency`](../../devkit/documents/ProjectGraphDependency)\>\>
---
### calculateTargetDepsFromFiles
`Private` **calculateTargetDepsFromFiles**(`sourceProject`): `Map`<`string`, `Set`<`string`\>\>
#### Parameters
| Name | Type |
| :-------------- | :------- |
| `sourceProject` | `string` |
#### Returns
`Map`<`string`, `Set`<`string`\>\>
---
### getUpdatedProjectGraph ### getUpdatedProjectGraph
**getUpdatedProjectGraph**(): [`ProjectGraph`](../../devkit/documents/ProjectGraph) **getUpdatedProjectGraph**(): [`ProjectGraph`](../../devkit/documents/ProjectGraph)
@ -279,22 +230,6 @@ Merges the nodes and dependencies of p into the built project graph.
--- ---
### removeDependenciesWithNode
`Private` **removeDependenciesWithNode**(`name`): `void`
#### Parameters
| Name | Type |
| :----- | :------- |
| `name` | `string` |
#### Returns
`void`
---
### removeDependency ### removeDependency
**removeDependency**(`sourceProjectName`, `targetProjectName`): `void` **removeDependency**(`sourceProjectName`, `targetProjectName`): `void`

View File

@ -10,10 +10,6 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
- [constructor](../../devkit/documents/Workspaces#constructor) - [constructor](../../devkit/documents/Workspaces#constructor)
### Properties
- [root](../../devkit/documents/Workspaces#root): string
### Methods ### Methods
- [readWorkspaceConfiguration](../../devkit/documents/Workspaces#readworkspaceconfiguration) - [readWorkspaceConfiguration](../../devkit/documents/Workspaces#readworkspaceconfiguration)
@ -30,12 +26,6 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
| :----- | :------- | | :----- | :------- |
| `root` | `string` | | `root` | `string` |
## Properties
### root
`Private` **root**: `string`
## Methods ## Methods
### readWorkspaceConfiguration ### readWorkspaceConfiguration

View File

@ -32,7 +32,7 @@ export function generateDevkitDocumentation() {
); );
execSync( execSync(
`rm -rf docs/generated/devkit && pnpm typedoc build/packages/devkit/index.d.ts --tsconfig build/packages/devkit/tsconfig.lib.json --out ./docs/generated/devkit --plugin typedoc-plugin-markdown --plugin @nx/typedoc-theme --hideBreadcrumbs true --disableSources --allReflectionsHaveOwnDocument --publicPath ../../devkit/ --theme nx-markdown-theme --readme none`, `rm -rf docs/generated/devkit && pnpm typedoc build/packages/devkit/index.d.ts --tsconfig build/packages/devkit/tsconfig.lib.json --out ./docs/generated/devkit --plugin typedoc-plugin-markdown --plugin @nx/typedoc-theme --hideBreadcrumbs true --disableSources --allReflectionsHaveOwnDocument --publicPath ../../devkit/ --theme nx-markdown-theme --excludePrivate --readme none`,
execSyncOptions execSyncOptions
); );
execSync( execSync(