search

kieker-monitoring / kieker

Kieker's main repository
Apache License 2.0
70 stars 41 forks source link

[KIEKER-557] Add JavaDoc to binary Kieker releases #1149

Open rju opened 1 week ago

rju commented 1 week ago

JIRA Issue: KIEKER-557 Add JavaDoc to binary Kieker releases Original Reporter: Jan Waller

This would enable better autocompletion in Eclipse.

Checklist:

rju commented 1 week ago

author André van Hoorn -- Sat, 24 Nov 2012 16:54:02 +0100

Does this mean that
1. Sources or the javadoc should be included in the Kieker Jars?
2. That provide them as a separate .jar or .zip file?
3. Or even unzipped in, e.g., doc/api/ or doc/javadoc?

My suggestion would be as follows:
For KIEKER-483 Done , we need the following additional artifacts (see [/ticket/515#comment:21]):
a. kieker-1.6-sources.jar and kieker-1.6-javadoc.jar
a. kieker-1.6-sources_emf.jar and kieker-1.6_emf-javadoc.jar
a. kieker-1.6-sources_aspectj.jar and kieker_aspectj-1.6-javadoc.jar

rju commented 1 week ago

author Jan Waller -- Mon, 26 Nov 2012 16:43:30 +0100

I am unable to reproduce the problem locally.

rju commented 1 week ago

author André van Hoorn -- Mon, 26 Nov 2012 16:54:27 +0100

Replying to [jwa|comment:3]:
> I am unable to reproduce the problem locally.

Did you try this with a clean workspace?

rju commented 1 week ago

author Jan Waller -- Mon, 26 Nov 2012 17:16:15 +0100

Ok, I am able to partially reproduce the problem, whatever the problem actually is.
Some entries have documentation, other don't.

We could try to add debuglevel=lines, vars, source to the javac tasks. This should embed many of the most needed information into the file. Alternatively we could consider turning debug mode off and simply expect people to attach the sources or javadoc releases to their binary files.

rju commented 1 week ago

author Jan Waller -- Mon, 26 Nov 2012 17:25:01 +0100

Makes no difference. Some methods have information, others don't. Randomly? Perhaps some timeout when searching.

Is debug mode good or bad for a release?

rju commented 1 week ago

author André van Hoorn -- Wed, 6 Mar 2013 15:59:03 +0100

What does it (not) change?

rju commented 1 week ago

author Jan Waller -- Thu, 7 Mar 2013 12:20:08 +0100

There should be no problems with debug enabled in releases.
Concerning the actual ticket: worksforme?
There is not anything we can do about it.
Everybody can include the provided javadoc or sources to get perfect code compeltion.