question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[BUG] Documentation of parameters

See original GitHub issue

I tried to document the parameters of a method wih the following code:

/**
 * @param {string} somebody Somebody's name.
 */
public sayHello(somebody) {
    alert('Hello ' + somebody);
}

Unfortunately, the description of the parameter is not included in the generated documentation. Is there a way to do it?

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:7 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
vogloblinskycommented, Jan 16, 2017

Typescript AST API provide simple comment extraction without support of JSDoc tags. https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript But APi seems available : https://github.com/Microsoft/TypeScript/blob/2.1/src/compiler/utilities.ts#L1507 I will add a complete support like Typedoc soon.

0reactions
lock[bot]commented, Oct 1, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Sample Bug Report - Software Testing Help
The Sample, Bug/Defect Report given below will give you an exact idea of how to report a Bug in the Bug Tracking Tool?...
Read more >
Which parameters are considered while writing good defect ...
A defect report documents an anomaly discovered during testing. · After uncovering a defect (bug), testers generate a formal defect report. · DEFECT...
Read more >
Defect Management Process in Software Testing (Bug Report)
A Bug Report in Software Testing is a detailed document about bugs found in ... of test execution is evaluated via following two...
Read more >
4.1. Parameters — Bugzilla 5.0.6 documentation
This page allows for setting restrictions and other parameters regarding attachments to bugs. For example, control size limitations and whether to allow ...
Read more >
What are the parameters of defect report in software testing
Defect tracking parameters: · Specified Test Data. Make sure that, test data what you have mentioned in the defect report, it should be...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found