apify icon indicating copy to clipboard operation
apify copied to clipboard

[HTMLDocument.js] Missing all Methods

Open redmunds opened this issue 10 years ago • 2 comments

File LiveDevelopment/Documents/HTMLDocument.js is missing all of the Methods. They all (most?) have JSDoc comments, so I'm not sure why they are not in generated file.

redmunds avatar May 29 '14 18:05 redmunds

Hi @redmunds,

This is initially caused because HTMLDocument constructor is not annotated with the @constructor tag. This is causing the processors not to catch the module, and so, the next methods fail to be assigned to a class because we didn't initialize one.

If you add the @constructor annotation, then it produces the correct documentation. Do you think we should try and make this logic more robust to somehow catch aditional constructors, or at least print orphan methods somewhere?

jbalsas avatar May 30 '14 13:05 jbalsas

That's ok for now.

If we already have orphan methods (or whatever) collected, then it makes sense to add them to bottom of doc in an Orphan section -- that would make it easier for the team to find code that is missing JSDoc annotations. But making the logic smarter is low priority for now.

redmunds avatar May 30 '14 14:05 redmunds