Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 317291 - PHPDoc starting with /*** are highlighted like Multi line comments
Summary: PHPDoc starting with /*** are highlighted like Multi line comments
Status: CLOSED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: PDT (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: PHP Core CLA
QA Contact: Sylvia Tancheva CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-18 08:37 EDT by Teodor Kirkov CLA
Modified: 2020-05-14 11:16 EDT (History)
4 users (show)

See Also:

Attachments
Wrong tooltip suggestion (69.47 KB, image/png)
2010-06-18 08:37 EDT, Teodor Kirkov CLA 		no flags Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Teodor Kirkov CLA 2010-06-18 08:37:02 EDT 
Build Identifier: 2.2.0.v20100616

If have multi line comment entered at PDT Editor at some cases entered parameters there are read like a PHPDoc comment

Reproducible: Always

Steps to Reproduce:
1.Have the following code at PDT
<?php
/***
 * Main description
 * @param test
 * @author test
 */
function test (){	
}
$test = te| //invoke content assist at | sign

2. At CA look at suggested for test() tooltip
3. Hover over test() definition and look again tooltip

Expected result:
This is not a PHPDoc comment so at tool tips must have only function name without any additional information - it must be the same like use /* for comment start

Actual result:
At tool tips have additional information about functions comment - can see whole information like a PHPDoc, but this is not a PHPDoc - look attached
Comment 1 Teodor Kirkov CLA 2010-06-18 08:37:39 EDT 
Created attachment 172210 [details]
Wrong tooltip suggestion
Comment 2 Jacek Pospychala CLA 2010-06-20 16:08:24 EDT 
It's nice catch, however PHPDocumentor manual doesn't say that such comments are not phpdoc blocks. They say that "every DocBlock comment is a C-style comment with two leading asterisks (*)". So imho we neither should be making any assumptions or guesses about user intentions to not break compatibility with PHPDocumentor.

For a counter-example, one could prefer following commenting style and argue that it's valid phpdoc:

/*******************
 * My super-important method with lots of asterisks.
 *******************/


makes sense Teo?
Comment 3 Zhongwei Zhao CLA 2010-06-20 20:06:54 EDT 
Hi Teo

It is my fault that I mislead you,I asked Roy about this bug,and he also thought 
/***
 * Main description
 * @param test
 * @author test
 */
is a phpdoc,so the problem is the above phpdoc is highlighted wrongly:)
Comment 4 Jacek Pospychala CLA 2010-06-21 03:42:35 EDT 
ah so now the fix is to make comments starting with "/***" blue, instead of green, like on Teo's screenshot, yes?
updating title a little to match our new target :-)
Comment 5 Thierry BLIND CLA 2014-11-01 13:37:13 EDT 
My proposed fix is ​​available:
https://git.eclipse.org/r/#/c/35756/

Thierry.
Comment 7 Sylvia Tancheva CLA 2014-11-27 07:29:23 EST 
Comment is now blue instead of green. Closing