You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I would like to see in documentation correct types in a property description and function signature.
Reproduce the error
Write follow class using JSDoc comments
exportclassAppComponent{title: string='Title';/** * First line * * Second line * * @param {number} dig The target to process number * @param {string} str The target to process string * @param {boolean} bool The target to process bool * * @example * This is a good example * testCommentFunction(1, 'test', true); * * @returns The processed target number */testCommentFunction(dig: number,str: string,bool: boolean): object{return{};}}
Then opening documentation
In property description
The text was updated successfully, but these errors were encountered:
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.
lockbot
locked as resolved and limited conversation to collaborators
Oct 1, 2019
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Overview of the issue
All function parameters and class properties are marked with a type void.
Operating System, Node.js, npm, compodoc version(s)
systeminfo: OS Microsoft Windows 10 Pro, version 10.0.15063 N/A build 15063
node -- version: 6.9.3
npm --version: 3.10.10
compodoc --version: 1.0.0-beta.11
Angular configuration, a
package.json
file in the root folderCompodoc installed globally or locally ?
locally
Motivation for or Use Case
I would like to see in documentation correct types in a property description and function signature.
Reproduce the error
Write follow class using JSDoc comments
Then opening documentation
![image](https://user-images.githubusercontent.com/28362919/27988612-7ec6fdd2-642e-11e7-8046-50f88320b70a.png)
In property description
![image](https://user-images.githubusercontent.com/28362919/27988618-a1e929b6-642e-11e7-8ed0-0e366b515d6f.png)
The text was updated successfully, but these errors were encountered: