doc: add basic java docs and java doc maven plugin

[nitin-vavdiya]

Description

Basic Java doc added with Java doc maven plugin

It will create a javadoc.jar file with mvn install command

To verify Java doc run ./mvnw javadoc:javadoc

Java dock verification was added with compile goal, which means if there is any issue in Java doc then the code will not compile.

Closes #19

[borisrizov-zf]

Hi @nitin-vavdiya, can you update the contents of the docs to some of the key components? I think we can fix the rest as we go.

[borisrizov-zf]

Closes #19

[nitin-vavdiya]

suggestions are fixed in new commit

[florianrusch-zf]

I have not yet completed the review.

[nitin-vavdiya]

I have not yet completed the review.

Okay, let me know. Will fix all suggestions in one go

[borisrizov-zf]

@carslen do we need an IP check? The handbook defines "project content" as any kind of content. Although this is just class documentation, it probably still falls under the >1000 SLOC rule.

[carslen]

@carslen do we need an IP check? The handbook defines "project content" as any kind of content. Although this is just class documentation, it probably still falls under the >1000 SLOC rule.

I did not check the hole PR, but if it is only comments, then I'd approve the PR without starting a IP-Check.

[borisrizov-zf]

@carslen do we need an IP check? The handbook defines "project content" as any kind of content. Although this is just class documentation, it probably still falls under the >1000 SLOC rule.

I did not check the hole PR, but if it is only comments, then I'd approve the PR without starting a IP-Check.

Yes, it's only Javadoc on each class. Thanks for the help :)

[borisrizov-zf]

@nitin-vavdiya please rebase as we've merged two branches.

[nitin-vavdiya]

@nitin-vavdiya please rebase as we've merged two branches.

done

[florianrusch-zf]

@nitin-vavdiya please change the target branch to the develop branch

[nitin-vavdiya]

@nitin-vavdiya please change the target branch to the develop branch

there is no develop branch

[borisrizov-zf]

@nitin-vavdiya please change the target branch to the develop branch

yes this repo directly merges into main.

[florianrusch-zf]

@nitin-vavdiya please change the target branch to the develop branch

there is no develop branch

ahhh sorry, mixed the repository. :-/

[florianrusch-zf]

But why is then this PR adding the following files? They should be already on the main branch.

[borisrizov-zf]

@nitin-vavdiya seems your rebase didn't work correctly. can you double check?

[borisrizov-zf]

Please recheck old comments from Florian, as the rebase has removed some changes.

[nitin-vavdiya]

Please recheck old comments from Florian, as the rebase has removed some changes.

done

[carslen]

@florianrusch-zf please review if your requested changes have been applied.

[borisrizov-zf]

@florianrusch-zf ping

[florianrusch-zf]

It's way to much to do a proper review on this...I would say, lets merge it and improve the comments, when revisiting the places in later changes. WDYT? :-/

[borisrizov-zf]

This can be merged now, with the understanding that we'll improve as we go.

[florianrusch-zf]

@nitin-vavdiya please apply the requested changes from @borisrizov-zf

If they got applied, we can continue with the merge.

[nitin-vavdiya]

@nitin-vavdiya please apply the requested changes from @borisrizov-zf

If they got applied, we can continue with the merge.

Yes, changes are applied

[florianrusch-zf]

No, the changes are not applied:

• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371742216
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371742617
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371744141
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371744665

[nitin-vavdiya]

No, the changes are not applied:

• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371742216
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371742617
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371744141
• https://github.com/eclipse-tractusx/SSI-agent-lib/pull/16/files/26951b5a0fe67660f5e988c2f0243e6c6e5a9eea#r1371744665

done

[florianrusch-zf]

build pipeline is running into a timeout while trying to pull a dependency. Will retry tomorrow

[borisrizov-zf]

I think the Fraunhofer server is down.