Comments (6)
Hi. What exactly is missing? Are you looking for the @preferred
tag to be implemented or are @packageDocumentation
tags ignored when merging the modules?
Could you post the version of TypeDoc and this plugin that you are using and also your TypeDoc config?
from typedoc-plugin-merge-modules.
Hello. The following is my config, passed as arguments to the command:
typedoc --tsconfig ./tsconfig.json --mergeModulesMergeMode module --readme ./README.md --out docs/ src/
my versions:
"typedoc": "^0.21.9",
"typedoc-plugin-merge-modules": "^3.0.2",
I think I am looking for both. Currently I have a doc comment that looks like this
/ *
* Comment content
* @packageDocumentation
* @module Transformation
* @preferred
*/
This comment does not appear on the index for the Transformation module. In fact, it does not appear anywhere.
I was hoping to be able to add a documentation page for the home page of a module in order to explain how it works properly.
from typedoc-plugin-merge-modules.
I'm not familiar with these module comments but I will take a look and report back to you.
PS: You need to start the comment with /**
right?
from typedoc-plugin-merge-modules.
I released 3.1.0 which adds the functionality you are looking for. Instead of @preferred
you need to use @mergeTarget
. You only need to use this new tag if more than one of the modules that are merged have a comment.
Please see if it works as expected and report back so we can close this issue. Thanks.
from typedoc-plugin-merge-modules.
It works wonderful. Thank you very much for the incredibly quick response and fix.
from typedoc-plugin-merge-modules.
Glad to hear. Please report back if you find any issues.
from typedoc-plugin-merge-modules.
Related Issues (11)
- Should this plugin also replace "default" with the field name? HOT 12
- Namespaces and Interfaces are not merged. HOT 6
- merge those module has the same name but in different categories HOT 5
- merge things into the same file HOT 5
- Usage with monorepo doesn't seem to work HOT 16
- When the plugin is turned off it still renames default exports HOT 1
- Error when running typedoc HOT 2
- Interface and Properties names are not replacing 'default' HOT 3
- Plugin fails to load with typedoc 0.22.3 HOT 2
- Difficulty using options HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typedoc-plugin-merge-modules.