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 255966 - The types that use the "<" or ">" characters are shown wrongly in the documentation pop-up.
Summary: The types that use the "<" or ">" characters are shown wrongly in the documen...
Status: RESOLVED FIXED
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 8.1
Hardware: PC Linux
: P3 normal (vote)
Assignee: Reema
URL: http://usejsdoc.org/tags-type.html
Keywords:
Depends on:
Blocks:
 
Reported: 2015-10-16 07:28 UTC by negora
Modified: 2017-04-28 07:52 UTC (History)
0 users

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 negora 2015-10-16 07:28:56 UTC
The types that use the "<" or ">" characters are shown wrongly in the documentation pop-up, the one that appears when you push [CONTROL] + [SPACE] to get the auto-completion. I'm not referring to the pop-up where you actually choose the function, but the one which shows you the documentation to the functions list.

This happens when you document an Array using the <> syntax or an Object that works as a dictionary or map of keys and values:

  Array<String>
  Array.<String>
  Object<String,Student>
  Object.<String,Student>

In the case of the Array you can use this alternative syntax:

  String[]

But in the case of the Object, you can only use the one above, so you're much more limited.

In the pop-up where you choose the function, the type is shown right. So I guess that it has to do with the parsing of the HTML in the documentation pop-up, which interprets the "<" and ">" characters as tag delimiters, and hides what is inside of them. If I use the "&lt;" and "&gt;" HTML sequences, the characters are shown right in the pop-up (but not in the auto-completion pop-up, obviously).
Comment 1 Petr Pisl 2015-10-16 09:11:13 UTC
Reproducible. 

@negora: you are right. It looks like problem with displaying < and > which are interpreted as html tag in documentation. Thanks
Comment 2 Quality Engineering 2017-04-01 03:14:29 UTC
Integrated into 'main-silver', will be available in build *201704010002* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)

Changeset: http://hg.netbeans.org/main-silver/rev/e1ccf607d94c
User: Reema <Reema@netbeans.org>
Log: #255966: chars < and > shown wrongly in cc doc popup
Corrected code formatting.
Comment 3 Quality Engineering 2017-04-12 02:04:03 UTC
Integrated into 'main-silver', will be available in build *201704120002* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)

Changeset: http://hg.netbeans.org/main-silver/rev/cb282b4a6fd5
User: Reema <Reema@netbeans.org>
Log: #255966: Fixed failing jsdoc cc usecase in test 226930