ansaurus

Question

Special HTML characters in phpDocumentor in the NetBeans IDE

Answer 1

A:

I would have thought surely phpDocumentor are right by definition? It's their format after all.

It does seem pretty undesirable to be doing an HTML-decode at this stage; the whole idea of text-markup systems like this is to avoid HTML details like entity reference escaping. What happens to any literal HTML you put in, does NetBeans try to render it?

bobince 2010-02-11 19:37:33

If I use something like <strong>foo</strong> I see "foo" in bold in the NetBeans IDE.

AlexV 2010-02-11 20:08:42

Oh dear! That doesn't seem like a good feature to me. What about `<script>alert('grrrrr!')</script>`? :-)

bobince 2010-02-11 20:48:15

For this I get " abr />"... Quite stange!

AlexV 2010-02-11 21:22:22

[scratches head]

bobince 2010-02-11 21:23:05

Answer 2

A:

Well the right way to do anything, in regards to handling special characters, is to use the actual characters you want and convert them at the moment you need to.

Therefor the correct way is to use actual < > & characters in your comments and the phpDoc addon needs to convert them to the HTML encoded versions for the .HTML files, if it doesn't do that, then it's them who is wrong, despite what they do or say.

TravisO 2010-02-11 21:02:52

Answer 3

A:

After some reseach it seems that phpDocumentor/NetBeans must interpret some tags. As you can see on Wikipedia here, 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. Currently NetBeans interpret all tags. This is a bug IMO since phpDocumentor docBuilder only interpret some tags.

I opened an issue (180636) on the NetBeans website.

Hopefully it will be fixed soon...

AlexV 2010-03-09 14:04:43

This is now fixed in NetBeans 6.9.

Activist 2010-07-07 18:27:29

Cool thanks for the update!

AlexV 2010-07-07 18:31:56

ansaurus

tags:

views:

answers:

Special HTML characters in phpDocumentor in the NetBeans IDE

related questions