Comments (1)
Search terms
Question
Can typedoc collect comments in a function body? For example, the source code is as follows: ` /**
- Here's an example
*/
function demoFunc(x, y) {
const sum = x + y;
// If sum > 0 function returns sum, otherwise the function returns -1
if (sum>0) {
return sum;
} else {
return -1;
}
}
`I want typedoc to collect comments that contain
If sum > 0 function returns sum, otherwise the function returns -1
; If typedoc is not currently supported, can I implement it by developing a typedoc plugin?
from typedoc.
Related Issues (20)
- Semantic Versioning HOT 3
- Property 'withResolvers' does not exist on type 'PromiseConstructor'. HOT 3
- How can I make entry points a flat list in the navigation? HOT 1
- Is there a way to inline a type into a function? without creating another page for the type? HOT 2
- How to pass externalSymbolLinkMappings from the command line? HOT 2
- Support `@hideconstructor` JSDoc tag to hide constructors from classes. HOT 5
- Any way to get packages strategy to work with merge module plugin? HOT 3
- Generating documentation for a constructed class? HOT 2
- Feature request: display warning and error count like eslint. HOT 2
- Supporting generated nested namespaces HOT 2
- Should validation work in watch mode? HOT 2
- How to document each type in `export type Foo = 'foo1' | 'foo2'? HOT 11
- Typedoc took 2.5 hours in conversions HOT 8
- Missing doc when returned field is not an object literal HOT 1
- Keep enum/const name instead of displaying number or string as return type HOT 2
- Plugins: Icons invisible when a large script is added on `head.end` HOT 3
- install from git not work? HOT 3
- `0.26 Beta`: Add `json5` to defaults in option declaration for `highlightLanguages` . HOT 3
- `0.26 Beta`: TS 5.5 `@import` comments passthrough in declarations to documentation. HOT 2
- Decouple `Renderer` class from HTML output
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.