Comments (2)
Not supported by TypeDoc, you could write a plugin to do this, however. Doing so is going to be rather annoying because TypeScript doesn't have any API to do this, so you'd have to do it yourself.
For the TypeDoc part of this, listen to Converter.EVENT_CREATE_SIGNATURE
For the TypeScript comment collection, you'll probably need node.forEachChild
to recurse through the function's body, if you care, this will also need to recurse... this should get you started:
node.body.forEachChild(node => console.log(ts.getLeadingCommentRanges(sourceFile.text, node.pos)))
I highly recommend ts-ast-viewer for experimenting with what's available on a node.
from typedoc.
https://www.npmjs.com/package/typedoc-comments I ran across this today, looks like it might do what you're after
from typedoc.
Related Issues (20)
- feat: render readthedocs flyout menu for default theme HOT 3
- Are there runtime traversal utils available for browser usage? HOT 6
- Support using full hexsha as default gitRevision value HOT 1
- Option `sitemapBaseUrl` is not documented HOT 1
- How to reference a method with a symbol name? HOT 3
- No footer in the default theme and renderhooks HOT 2
- Does Accessor not support @readonly? HOT 3
- Github links go to previous commit HOT 2
- Exception when writing HTML output:`TypeError: project.getReflectionsByKind is not a function` HOT 1
- Is it possible to generate output without either sidebar? HOT 2
- Unable to build the site HOT 3
- When a function parameter has type `NoInfer<T>`, `T` is removed from the generated doc HOT 1
- Can typedoc collect comments in a function body? HOT 1
- Using typedoc in vite will result in compilation failure HOT 2
- Typedoc will automatically filter undefined and null types HOT 2
- Where can I get the definition type of the generated docs.json file with json output format HOT 1
- Child class with overridden method does not have documentation from non-exported parent HOT 2
- types used in Returns section of functions are shown in white instead of green / red HOT 2
- Header is navbar on mobile is overriding itself HOT 3
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.