Opened 2 years ago

Closed 2 years ago

#21376 closed enhancement (fixed)

add javadoc metrics style

Reported by: iwakeh Owned by: metrics-team
Priority: Medium Milestone:
Component: Metrics Version:
Severity: Normal Keywords:
Cc: RaBe Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Add common javadoc style to metrics-base.

Child Tickets

Change History (9)

comment:1 Changed 2 years ago by RaBe

Here you can download the two files you need to include in the javadocs builds:

javadocs.cc-ltd.net/descriptor/stylesheet.css
javadocs.cc-ltd.net/descriptor/tor-onion.png

comment:2 Changed 2 years ago by iwakeh

Status: newneeds_review

Here is a branch of metrics-base with the new style included.

Works fine locally. Please review.

comment:3 Changed 2 years ago by karsten

Cc: RaBe added
Status: needs_reviewneeds_revision

I didn't try this out yet, but quick question before I do: Could it be that the line @import url('resources/fonts/dejavu.css'); refers to a file that does not exist? At least my browser complains about that file being missing on RaBe's server, that is, only in the web console. Do we need that file? And if it's not available, can we even use the DejaVu Sans font a few lines later?

comment:4 Changed 2 years ago by iwakeh

Good catch! Indeed, there is no such file or fonts. After a small search this seems to be a re-occurring bug in the jdk javadoc tool.

Removed the line in my branch.

(Are the fonts taken from the browser or os?)

comment:5 Changed 2 years ago by karsten

Looks good to me. Let's also hear what RaBe says about where fonts are taken from.

comment:6 Changed 2 years ago by iwakeh

Status: needs_revisionneeds_review

comment:7 Changed 2 years ago by karsten

Owner: changed from metrics-team to RaBe
Status: needs_reviewassigned

RaBe, can you comment on the fonts question above?

comment:8 Changed 2 years ago by RaBe

Owner: changed from RaBe to metrics-team

I did not even touch the font of the default JavaDoc stylesheet :) But I agree with it being the mentioned known bug, so you can just remove the import line. On systems that have Deja Vu installed it will still be displayed, for other systems it falls back to Arial, which should be fine!

comment:9 Changed 2 years ago by karsten

Resolution: fixed
Status: assignedclosed

Great, thanks for the confirmation!

I just cherry-picked the two commits and pushed them to metrics-base master. Closing. Thanks!

Note: See TracTickets for help on using tickets.