Re: [xwiki-devs] [xwiki-notifications] r15020 - in platform/core/trunk/xwiki-xml/src/main/java/org/xwiki/xml: html internal/html

3 Jan 2009

Hi,

This is fine but it needs to be documented in the method with the
...
  parameter signature to explain why the params are not
used.

In HTMLCleaner#clean(Reader, Map) method i have included a javadoc comment
which includes :

"@param cleaningParameters Additional parameters (implementation dependent)
for cleaning."

And in DefaultHTMLCleaner:

"/**
 * {@inheritDoc}
 * <p>
 * {@link DefaultHTMLCleaner} does not allow fine-tuning of html cleaning
via parameters.
 * </p>
 */"

I thought this was enough because of {@inheritDoc} tag plus the additional
comment.

Sorry, may be I have misunderstood something.

Thanks.

- Asiri