Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Support For Whitelisted HTML Tag Passthrough #43

Open
justco opened this issue Apr 9, 2015 · 0 comments
Open

Support For Whitelisted HTML Tag Passthrough #43

justco opened this issue Apr 9, 2015 · 0 comments

Comments

@justco
Copy link

justco commented Apr 9, 2015

I'm not sure if this is intended or not, but HTML tags will pass through for only the brief description of a method, but not for the full method description. To be more specific...

In the method htmlForClassModel() in FileManager.java, when generating the HTML for <div class="methodTOCDescription">, escapeHTML() is NOT called, but when generating the HTML for <div class="methodDescription">, escapeHTML() IS called.

I understand this is a bit tricky because you want to be able to support < and > being shown in the documentation and not embedded as html tags, but it's a bit confusing that it will pass tags through for one part and escape them in another.

As for the passthrough, perhaps escapeHTML() in FileManager.java could be overloaded to accept an array of whitelisted ignore-tags which you know won't mess up the structure of the generated doc. Then, depending on what part of the doc you are generating when you call escapeHTML() you can toss in different acceptable tags like <code>, <ul>, <ol>, <li>, <pre>, <p> and maybe <b>, <i>.

@justco justco changed the title Full Support For HTML Code Tag Passthrough Support For Whitelisted HTML Tag Passthrough Apr 10, 2015
@justco justco closed this as completed Sep 17, 2015
@justco justco reopened this Sep 17, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant