Change autogenerated Javadoc for Tiers

[carlosuc3m]

HEllo @StRigaud ,
Deployment seems to be almost ready but I am finding an error generating the JAvadoc, which is required to deploy to scijava.

The tag @see cannot be used together with links. The Tier generator uses it for every tier:

clesperantoj_prototype/src/main/java/net/clesperanto/kernels/Tier1.java

Line 27 in f40abd4

* @see https://clij.github.io/clij2-docs/reference_absolute

The link needs to be embedded in html:
instead of
@see https://clij.github.io/clij2-docs/reference_absolute
we need to use
@see <a href="https://clij.github.io/clij2-docs/reference_absolute">reference_absolute</a>

[StRigaud]

Ffs ...

Okay, I will remove the tag for now. It will be easier to deal with this later

[StRigaud]

I merged a fix but the issue is not solved, I will find an alternative later when more urgent issue are done

[carlosuc3m]

There are more Javadoc errors that stop the deploymnet (mvn does not tell you all at once).
Now the issue is with using &, > and <.
They should be:

& -> &
> -> >
< -> &lt;
I can have a look at the autogenerator for more possible conflicts

[StRigaud]

So:

• & var -> &var
• var > -> var >
• < var -> <var

is it correct?

[StRigaud]

@carlosuc3m can you actually point to a piece of code to correct / an example. I don't understand well the issue

[StRigaud]

Ha got it, the charactere in the JavaDoc need to be replace by code charactere

[carlosuc3m]

Yess sorry. Basically in javadocs there are some characters reserved for certain things that cannot be used.
These special characters need to be substituted for their html equivalents

For example this line uses < which cannot be used for javadoc.

clesperantoj_prototype/src/main/java/net/clesperanto/kernels/Tier3.java

Line 25 in d1a10d9

* @return ArrayList<Float>

The line is:
* @return ArrayList<Float>

It should be

* @return ArrayList<Float>

So the mvn javadoc plugin recognises it

[StRigaud]

I made a PR, the JavaDoc look like nothing but hopefully its ok

[carlosuc3m]

In this line

clesperantoj_prototype/src/main/java/net/clesperanto/kernels/Tier1.java

Line 1993 in d1a10d9

* If it was > 0, it will be 1.

Instead of
* If it was > 0, it will be 1.

do
* If it was > 0, it will be 1.

[carlosuc3m]

Also we might need javadoc for Javacpp xd, lets see

[carlosuc3m]

Also I am trying right now if it works but there is a difference between html and non-html <> use.

You can do
* <pre>f(x) = x</pre> For binary images, use binaryNot.

but you cannot do 5 > 4

[StRigaud]

I simply did a full character replacement, if it work I am fine and we will see later for a cleaner writing

[StRigaud]

Also we might need javadoc for Javacpp xd, lets see

That would be annoying

[carlosuc3m]

It builds the javadoc now without any issue 🥳

[StRigaud]

Not urgent but for later, what can I use instead of the @see tag to display links? or do I need to convert the links to html ?

[carlosuc3m]

It looks like it:
The correct link formatting is the following:
@see <a href="https://clij.github.io/clij2-docs/reference_absolute">reference_absolute</a>