Improve presentation of code blocks in Javadoc [SPR-10155]

[spring-projects-issues]

Chris Beams opened SPR-10155 and commented

Compare

http://static.springsource.org/spring-framework/docs/3.1.0.RELEASE/javadoc-api/org/springframework/context/annotation/Configuration.html

with

http://static.springsource.org/spring-framework/docs/3.2.0.RELEASE/javadoc-api/org/springframework/context/annotation/Configuration.html

The former used our custom Javadoc look and feel, while the latter uses JDK7's javadoc and its built in look and feel. This is an overall improvement, but it did mean losing our custom treatment of <pre class="code"> blocks, i.e. wrapping them in a div with a gray background, etc.

Perhaps we could consider re-introducing the requisite CSS here; I do think it makes a difference to provide that extra bit of visual distinction between prose and code. If it is simple enough to do, perhaps we could also consider adding a syntax formatting library (though that may require changing class metadata on the individual <pre> tag level, which would probably be out of scope or at least not worth the trouble.

See #12762, which is irrelevant unless and until we make this change.

---

Affects: 3.2 GA

Issue Links:

• Replace all <pre> with <pre class="code"> in JavaDoc [SPR-8108] #12762 Replace all

   with 
   in JavaDoc ("is depended on by")

Referenced from: commits 1c72406

[spring-projects-issues]

Phil Webb commented

Syntax Highlighting does not look like a particularly easy fix [1] but I have restored the code blocks.

[1] http://stackoverflow.com/questions/1391614/are-there-any-syntax-highlighting-plugins-for-javadoc