This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 221152 - JavaScript documentation should contain link to its web documentation
Summary: JavaScript documentation should contain link to its web documentation
Status: NEW
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 7.3
Hardware: PC Linux
: P3 normal (vote)
Assignee: Petr Pisl
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-10-31 09:14 UTC by Martin Fousek
Modified: 2015-10-10 11:02 UTC (History)
4 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Fousek 2012-10-31 09:14:32 UTC
According to the issue #220915. We are not able currently to bundle all JavaScript documentation so there could help to show users at least link to the external docs.

BTW, it includes need to get all links and bind them with the elements in the current JS signature files.
Comment 1 Petr Jiricka 2013-06-28 13:44:54 UTC
Martin probably will not have time to work on this for 7.4, reassigning to Petr. We should try to do this for 7.4 - changing to DEFECT.
Comment 2 Martin Fousek 2013-08-05 06:16:29 UTC
I think that it's needed to create map of every property and method of the JS documentation or at least of the base objects. There is a problem that every part of the documentation is taken from another source (there is no single good source which would gather all these docs).

It means that there must be introduced method which would guess the link (including i.e. URI subpath or #anchor) to the specific field according of the base JS element type (Core JS, DOM JS). But it's possible that we will not be able to implement it generally for objects and mapping for every field/method will be necessary.
Comment 3 Petr Jiricka 2013-08-05 12:16:52 UTC
Thanks for the evaluation Martin. Of course, maintaining a list of several hundred or more URLs would be unwieldy. I think for the first iteration of the solution, 100% accuracy is not critical, and 95% would be a good start. Would it be possible to easily do a minimal solution that would cover the majority of links, and then we can gradually make it more accurate my maintaining a (short) list of exceptions, or something like that? Thanks.
Comment 4 Martin Fousek 2013-08-05 13:07:28 UTC
(In reply to comment #3)
> Thanks for the evaluation Martin. Of course, maintaining a list of several
> hundred or more URLs would be unwieldy. I think for the first iteration of the
> solution, 100% accuracy is not critical, and 95% would be a good start. Would
> it be possible to easily do a minimal solution that would cover the majority of
> links, and then we can gradually make it more accurate my maintaining a (short)
> list of exceptions, or something like that? Thanks.

Of course that it's doable, not sure which percentage what can be done easily. I wanted only mention that it's possible that the object mapping needn't be sufficient and mapping of every method/property will be necessary.