Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Logo on every JavaDoc page

Tags:

java

javadoc

I need to put a corporate logo at the top of every JavaDoc page. I'm trying to use the -top option, but don't know how to code the image path -- the path is always relative to the package sub-directory. I don't want to put the same image file in every package sub-directory.

javadoc -top '' is what I've tried but the image (which is in the root of the javadoc tree) only shows up on the index page.

Edit: Unfortunately, this is going to be distributed as a ZIP and we won't be able to access the logo via a URL.

like image 763
artk2002 Avatar asked May 12 '16 15:05

artk2002


1 Answers

Pulling comments into an answer.

If you can, the easiest thing to do would be to just host your image externally and link to the full URL. If you can't host the image on your own website you could upload it to an image host like Imgur or a cloud hosting solution like Google Cloud Storage.

If you really need to distribute the image with the docs, your best bet will be to modify stylesheet.css after generating your docs as suggested in this question. Add:

.topNav {
  background: #4c6b87 url(resources/companyLogo.jpg) no-repeat right top;
 }

and store companyLogo.jpg in the resources folder.

like image 167
2 revs Avatar answered Oct 16 '22 07:10

2 revs