Bug 317172 - Long description missing in tooltips
Summary: Long description missing in tooltips
Status: CLOSED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: PDT (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P1 normal with 4 votes (vote)
Target Milestone: ---   Edit
Assignee: Thierry BLIND CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 316746 319658 (view as bug list)
Depends on:
Blocks: 319658
  Show dependency tree
 
Reported: 2010-06-17 09:20 EDT by Jacek Pospychala CLA
Modified: 2020-05-14 11:09 EDT (History)
10 users (show)

See Also:


Attachments
Windows Screenshot (14.33 KB, image/png)
2015-05-22 10:18 EDT, Sylvia Tancheva CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jacek Pospychala CLA 2010-06-17 09:20:00 EDT
Originally found in bug 314499:

I noticed only one issue, that also appears in non-CA tooltip. It's that
contents of phpdoc after an empty line are not included in tooltip.
For example:

/** Line1
 *
 * Line3
 * 
 * @author jacek
 *
 */
class Boo {

}

hovering over Boo (or tooltip in content-assist), will show only "Line1", but
not "Line3".

This is not a big issue, however, typically PDT generates phpdoc blocks like:
/**
 * 
 * Enter description here ...
 * @author jacek
 *
 */

And because of empty line, the "Enter description here..." doesn't appear in
tooltip.



Also see https://bugs.eclipse.org/bugs/attachment.cgi?id=171385
Comment 1 Zhongwei Zhao CLA 2010-06-17 09:30:34 EDT
*** Bug 316746 has been marked as a duplicate of this bug. ***
Comment 2 Mauro Molinari CLA 2010-07-13 04:58:31 EDT
*** Bug 319658 has been marked as a duplicate of this bug. ***
Comment 3 Mikko Rantalainen CLA 2013-03-27 03:27:16 EDT
I'm now missing BOTH short and long descriptions. Tooltips contain only method signature and all tags but no short or long description.

I'm running with following major components

Eclipse Platform	4.3.0.v20130116-202442-9QF7ZHV9G17FmbGOgGP9z-WNIeB9Kei9ob9CuuY	org.eclipse.platform.feature.group	Eclipse.org

PHP Development Tools (PDT)	3.2.0.201303261012	org.eclipse.php.feature.group	Eclipse.org

Dynamic Languages Toolkit - Core Frameworks	5.0.0.201302281810	org.eclipse.dltk.core.feature.group	Eclipse.org

I remember seeing at least short description when I used PDT 3.1.x with Eclipse 3.7.x. I'd prefer using PDT 3.2.x because it works otherwise much better than old versions.
Comment 4 Daniel Huss CLA 2013-05-02 05:34:33 EDT
I can also no longer see any function or class descriptions in PDT tooltips. Thank goodness I've found this bug entry, I was on the brink of insanity. There are no messages in the Eclipse error log.

I am using the following components:

  Composer	1.0.2.201304151710	com.dubture.composer.feature.feature.group	https://github.com/pulse00
  Dynamic Languages Toolkit - Core Frameworks	5.0.0.201304251210	org.eclipse.dltk.core.feature.group	Eclipse.org
  Dynamic Languages Toolkit - Core H2 Index Frameworks	5.0.0.201304251210	org.eclipse.dltk.core.index.feature.group	Eclipse.org
  Dynamic Languages Toolkit - Remote Development Support	5.0.0.201304251210	org.eclipse.dltk.rse.feature.group	Eclipse.org
  Eclipse Color Theme	0.12.0.201207240713	com.github.eclipsecolortheme.feature.feature.group	GitHub
  Eclipse SDK	4.2.2.M20130204-1200	org.eclipse.sdk.ide	null
  Eclipse UI Juno SR1 Optimizations	4.2.1.v20121220-2014	org.eclipse.ui.juno.feature.feature.group	Eclipse.org
  Eclipse UI Juno SR1 Optimizations Developer Resources	4.2.1.v20121220-2014	org.eclipse.ui.juno.feature.source.feature.group	Eclipse.org
  Json EditorFeature	0.9.54.201304072010	org.sourceforge.jsonedit.feature.feature.group	null
  PDT Extensions	0.16.0.201304151622	org.pdtextensions.feature.feature.group	http://pdt-extensions.org
  PDT Extensions Feature	1.0.12	com.dubture.pdt.feature.feature.group	https://github.com/pulse00
  PHP Copy/Paste Detection	0.2.2.R20100414000000	org.phpsrc.eclipse.pti.tools.phpcpd.feature.group	Sven Kiera
  PHP Development Tools (PDT)	3.2.0.201304241312	org.eclipse.php.feature.group	Eclipse.org
  PHP Development Tools (PDT) Source Code	3.2.0.201304241312	org.eclipse.php.source.feature.group	Eclipse.org
  PHP Mess Detector	0.1.0.R20110628000000	org.phpsrc.eclipse.pti.tools.phpmd.feature.group	Dejan Spasic
  PHP PEAR Library	1.2.2.R20120127000000	org.phpsrc.eclipse.pti.library.pear.feature.group	Sven Kiera
  PHP Tool Integration Core	1.6.0.R20111119000000	org.phpsrc.eclipse.pti.core.feature.group	Sven Kiera
  PHPUnit	0.8.0.R20111119000000	org.phpsrc.eclipse.pti.tools.phpunit.feature.group	Sven Kiera
  PTP Remote Development Tools (RDT)	6.0.4.201302122324	org.eclipse.ptp.rdt.feature.group	Eclipse PTP
Comment 5 Daniel Huss CLA 2013-05-06 07:17:10 EDT
Fixed for me after updating to:

PHP Development Tools (PDT)	3.2.0.201305051912
PDT Extensions	0.16.0.201305052056
Comment 6 Mikko Rantalainen CLA 2013-05-10 03:29:02 EDT
Confirming fixed in 
  PHP Development Tools (PDT)	3.2.0.201305080713	org.eclipse.php.feature.group	Eclipse.org

I get short and long descriptions in tooltip.

However, there's still one minor visual issue:

Given code

/**
 * Line 1
 *
 * Line 2
 * Line 3
 */
public function foo() {...}

I'd expect tooltip to say

"Line 1

Line 2 Line 3"

But instead it says

"Line 1

Line 2

Line 3"

PhpDoc parser should interpret double linefeed as a paragraph separator and single linefeed as source code formatting.
Comment 7 Michal Niewrzal CLA 2014-08-07 17:02:46 EDT
Just small patch to long description formatting (last comment) and I think this bug can be closed.

Patch: https://git.eclipse.org/r/#/c/31240/
Comment 9 Sylvia Tancheva CLA 2015-05-22 10:17:29 EDT
The last example looks fixed on Linux/OS X but on Windows it is till the same.
Comment 10 Sylvia Tancheva CLA 2015-05-22 10:18:28 EDT
Created attachment 253681 [details]
Windows Screenshot
Comment 11 Eclipse Genie CLA 2015-06-01 18:32:20 EDT
New Gerrit change created: https://git.eclipse.org/r/49149
Comment 13 Michal Niewrzal CLA 2015-06-02 07:05:56 EDT
Thanks Thierry!
Comment 14 Sylvia Tancheva CLA 2015-06-12 04:24:21 EDT
Looks OK now on windows too. Closing