Customize module names to correspond to exports

eclipse-langium · Sep 23, 2024 · 34f851b · 34f851b
1 parent e21044a
commit 34f851b
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 7 deletions.
diff --git a/packages/langium/src/generate/index.ts b/packages/langium/src/generate/index.ts
@@ -2,11 +2,12 @@
  * Copyright 2023 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium/generate
+ */
 
 export * from './generator-node.js';
 export type { SourceRegion, TextRegion, TraceRegion, TraceSourceSpec } from './generator-tracing.js';
 export * from './node-joiner.js';
 export * from './template-node.js';
 export { expandToString, expandToStringLF, expandToStringLFWithNL, expandToStringWithNL, normalizeEOL } from './template-string.js';
-
diff --git a/packages/langium/src/grammar/index.ts b/packages/langium/src/grammar/index.ts
@@ -2,7 +2,9 @@
  * Copyright 2023 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium/grammar
+ */
 
 // This file contains Langium grammar language internals.
 // It is not supposed to be exported with the general `langium` export.

diff --git a/packages/langium/src/index.ts b/packages/langium/src/index.ts
@@ -2,7 +2,9 @@
  * Copyright 2021 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium
+ */
 
 export * from './default-module.js';
 export * from './dependency-injection.js';

diff --git a/packages/langium/src/lsp/index.ts b/packages/langium/src/lsp/index.ts
@@ -2,7 +2,9 @@
  * Copyright 2021 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium/lsp
+ */
 
 export * from './completion/completion-provider.js';
 export * from './completion/follow-element-computation.js';

diff --git a/packages/langium/src/node/index.ts b/packages/langium/src/node/index.ts
@@ -2,7 +2,9 @@
  * Copyright 2022 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium/node
+ */
 
 export * from './node-file-system-provider.js';
 export * from './worker-thread-async-parser.js';
diff --git a/packages/langium/src/test/index.ts b/packages/langium/src/test/index.ts
@@ -2,6 +2,8 @@
  * Copyright 2021 TypeFox GmbH
  * This program and the accompanying materials are made available under the
  * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+ *
+ * @module langium/test
+ */
 
 export * from './langium-test.js';
diff --git a/packages/langium/typedoc.json b/packages/langium/typedoc.json
@@ -1,4 +1,5 @@
 {
+	"name": "Langium",
 	"entryPoints": [
 		"./src/index.ts",
 		"./src/generate/index.ts",
@@ -9,6 +10,10 @@
 	],
 	"tsconfig": "tsconfig.src.json",
 	"out": "./docs",
+	"navigation": {
+		"includeFolders": false
+	},
 	"includeVersion": true,
+	"sortEntryPoints": false,
 	"githubPages": true
 }