Opened 3 years ago

Last modified 3 years ago

#16714 confirmed Task

Add missing API jsdoc tags

Reported by: Robert Flaherty Owned by:
Priority: Nice to have (we want to work on it) Milestone:
Component: General Version: 4.6.0
Keywords: Cc:

Description

I started running into missing types, and having them is more helpful then having to look into the source. I don't know what kind of tool is generating the docs, and what validation can be achieved, like:

  • missing/mismatched @param count and names; I see Object gets spit out by default, so I assume there is some intelligent parsing of the parameters
  • missing @returns when body has return statement; this may be hard given nested classes

Anyway, I did a regexp search for methods in the SDK output that would have return types ((?:get|is|has|find|create|exists)
w*).

Attachments (1)

Scan.log (7.8 KB) - added by Robert Flaherty 3 years ago.

Download all attachments as: .zip

Change History (3)

Changed 3 years ago by Robert Flaherty

Attachment: Scan.log added

comment:1 Changed 3 years ago by Marek Lewandowski

Priority: NormalNice to have (we want to work on it)
Status: newconfirmed

@rflahert thanks for the feedback. We're using JSDuck for docs (you'll find information on it in our docs).

There are some mismatched places, actually thanks for a valuable log! I checked couple of methods and those might use some improvements.

Can I ask you what tool has been used for creating a log like this?

comment:2 Changed 3 years ago by Robert Flaherty

I wrote a quick file scanner and regexp matcher in Java. I assume you guys look for Javascriptbased tools. If its' useful I can upload it. Hooking in to JSDuck or submitting error detection to them is probably the better route.

Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy