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 180636 - Inline help in PHP for phpDocumentor tags
Summary: Inline help in PHP for phpDocumentor tags
Status: RESOLVED FIXED
Alias: None
Product: php
Classification: Unclassified
Component: Editor (show other bugs)
Version: 6.x
Hardware: PC All
: P4 normal (vote)
Assignee: Tomas Mysik
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-02-11 15:04 UTC by Activis
Modified: 2010-07-07 10:06 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Exception Reporter:

Attachments
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 Activis 2010-02-11 15:04:15 UTC 
When NetBeans pop the inline documentation in my PHP sources (based on the phpDocumentor syntax), I found out that if the phpDocumentor documentation contains "specials" HTML characters (like < > &), they are pased as HTML while they should be displayed (escaped) as text!

For example the following documentation

/** 
 * Add a new <link> to the <head> of the document. 
 */ 

Will be shown as:
"Add a new  to the  of the document."
In the NetBeans inline help.

I expected to see:
"Add a new <link> to the <head> of the document."
just like phpDocumentor docBuilder does.

It seems that NetBeans interpret those tags but I think they should be shows as-is (in plain text) just like the phpDocumentor tools do.
Comment 1 Activis 2010-02-12 08:09:04 UTC 
After some reseach it seems that phpDocumentor/NetBeans must interpret SOME tags. As you can see on Wikipedia (http://en.wikipedia.org/wiki/PHPDoc#DocBlock_Description_Details), only the following tags should be interpreted as HTML: b, code, br, i, kbd, li, ol, p, pre, samp, ul, var. All others tags should be displayed as plain text.
Comment 2 Tomas Mysik 2010-02-12 08:15:17 UTC 
IMHO using HTML entities would solve your problem (it's the same like in JavaDoc).
If not, please reopen. Thanks.
Comment 3 Activis 2010-02-12 08:19:03 UTC 
Yes HTML entities solves the problem in NetBeans but break my documentation made with phpDocumentor docBuilder.

You (NetBeans) parse *all* HTML while docBuilder parse *some* HTML. Both tools should be on the same standard and since NetBeans is using their standards I think you should fix this.
Comment 4 Tomas Mysik 2010-07-07 10:06:12 UTC 
Already fixed.

Product Version: NetBeans IDE Dev (Build 100702-a44c03e9ad9b)
Java: 1.6.0_20; Java HotSpot(TM) 64-Bit Server VM 16.3-b01
System: Linux version 2.6.32-23-generic running on amd64; UTF-8; cs_CZ (nb)