docs(core): hide private fields in docs

nrwl · Sep 23, 2023 · 76bc58d · 76bc58d · vercel · Sep 23, 2023
1 parent a49a84e
commit 76bc58d
Show file tree

Hide file tree

Showing 3 changed files with 1 addition and 76 deletions.
diff --git a/docs/generated/devkit/ProjectGraphBuilder.md b/docs/generated/devkit/ProjectGraphBuilder.md
@@ -15,8 +15,6 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
 ### Properties
 
 - [graph](../../devkit/documents/ProjectGraphBuilder#graph): ProjectGraph
-- [nonProjectFiles](../../devkit/documents/ProjectGraphBuilder#nonprojectfiles): FileData[]
-- [projectFileMap](../../devkit/documents/ProjectGraphBuilder#projectfilemap): ProjectFileMap
 - [removedEdges](../../devkit/documents/ProjectGraphBuilder#removededges): Object
 
 ### Methods
@@ -28,11 +26,8 @@ The ProjectGraphProcessor has been deprecated. Use a [CreateNodes](../../devkit/
 - [addImplicitDependency](../../devkit/documents/ProjectGraphBuilder#addimplicitdependency)
 - [addNode](../../devkit/documents/ProjectGraphBuilder#addnode)
 - [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency)
-- [calculateAlreadySetTargetDeps](../../devkit/documents/ProjectGraphBuilder#calculatealreadysettargetdeps)
-- [calculateTargetDepsFromFiles](../../devkit/documents/ProjectGraphBuilder#calculatetargetdepsfromfiles)
 - [getUpdatedProjectGraph](../../devkit/documents/ProjectGraphBuilder#getupdatedprojectgraph)
 - [mergeProjectGraph](../../devkit/documents/ProjectGraphBuilder#mergeprojectgraph)
-- [removeDependenciesWithNode](../../devkit/documents/ProjectGraphBuilder#removedependencieswithnode)
 - [removeDependency](../../devkit/documents/ProjectGraphBuilder#removedependency)
 - [removeNode](../../devkit/documents/ProjectGraphBuilder#removenode)
 - [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
 
 • `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**(): [`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**(`sourceProjectName`, `targetProjectName`): `void`

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

diff --git a/scripts/documentation/generators/generate-devkit-documentation.ts b/scripts/documentation/generators/generate-devkit-documentation.ts
@@ -32,7 +32,7 @@ export function generateDevkitDocumentation() {
   );
 
   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
   );
   execSync(