From 55f23932b4d89d5fa2e201ebeaf433258e35c5de Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 18 Jan 2012 11:02:34 +0100 Subject: [PATCH] Improve api doc generation - Touch up title text - Add 'header' (shows up in upper right and left of frameset) - Ensure @author attribution shows up (not true by default!) - Remove now-obsolete custom Javadoc CSS and background image --- build.gradle | 7 +- src/api/doc-files/th-background.png | Bin 2841 -> 0 bytes src/api/spring-javadoc.css | 178 ---------------------------- 3 files changed, 5 insertions(+), 180 deletions(-) delete mode 100644 src/api/doc-files/th-background.png delete mode 100644 src/api/spring-javadoc.css diff --git a/build.gradle b/build.gradle index 69b3e0afe3..3e75dd7203 100644 --- a/build.gradle +++ b/build.gradle @@ -879,8 +879,11 @@ reference { task api(type: Javadoc) { group = 'Documentation' description = 'Generates aggregated Javadoc API documentation.' - options.overview = 'src/api/overview.html' + title = "${rootProject.description} ${version} API" options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED + options.author = true + options.header = rootProject.description + options.overview = 'src/api/overview.html' source subprojects.collect { project -> project.sourceSets.main.allJava } @@ -967,7 +970,7 @@ task distZip(type: Zip, dependsOn: [docsZip, schemaZip]) { from subproject.sourcesJar from subproject.javadocJar } - } + } } // Create an optional "with dependencies" distribution. diff --git a/src/api/doc-files/th-background.png b/src/api/doc-files/th-background.png deleted file mode 100644 index 72d65e771f0dd4ab8840ca15ab9eec9c9e664957..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2841 zcmV+!3+D8RP)KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0000)Nkl&$u(bq3jF1*G;sr1OFqAOfkahT?00000NkvXXu0mjf^-)D& diff --git a/src/api/spring-javadoc.css b/src/api/spring-javadoc.css deleted file mode 100644 index c438fafa56..0000000000 --- a/src/api/spring-javadoc.css +++ /dev/null @@ -1,178 +0,0 @@ -/* stylesheet.css 2008/04/22 nicolekonicki */ - -/* - * - * Spring-specific Javadoc style sheet - * - */ - - - -.code -{ - border: 1px solid black; - background-color: #F4F4F4; - padding: 5px; -} - -body -{ - font: 12px Verdana, Arial, Helvetica, "Bitstream Vera Sans", sans-serif; - background-color: #fff; - color: #333; -} - - -/* Link colors */ -a -{ - color:#2c7b14; - text-decoration:none; -} - -a:hover -{ - text-decoration:underline; -} - -/* Headings */ -h1 -{ - font-size:28px; - color:#007c00; -} - -/* Table colors */ - -table -{ - border:none; -} - -td -{ - border:none; - border-bottom:1px dotted #ddd; -} - -th -{ - border:none; -} - -.TableHeadingColor th -{ - background-color: #efffcb; - background-image: url(doc-files/th-background.png); - background-repeat: repeat-x; - color:#fff; - font-size:14px; - height:26px; -} - -.TableSubHeadingColor -{ - background: #f7ffee; - -} -.TableRowColor -{ - background: #fff; -} - -.TableRowColor a -{ - border-bottom:none; - color:#2c7b14; - font-weight:normal; -} - -tr.TableRowColor:hover -{ - background:#eef2e1; -} - - -/* Font used in left-hand frame lists */ -.FrameTitleFont -{ - font-size: 120%; - font-weight:bold; -} - -.FrameTitleFont a -{ - color: #333; -} - -.FrameHeadingFont -{ - font-weight: bold; - font-size:95%; -} - -.FrameItemFont -{ - line-height:130%; - font-size: 95%; -} - -.FrameItemFont a -{ - color:#333; -} - -.FrameItemFont a:hover -{ - color:#249901; - border-bottom:none; - text-decoration:underline; -} - -/* Navigation bar fonts and colors */ -.NavBarCell1 -{ - background-color:#fff; - border:none; -} - -.NavBarCell1Rev -{ - background-color:#e3faa5; - border:1px solid #9ad00c; - padding:0; - margin:0; -} - -.NavBarCell1 a -{ - color:#333; - text-decoration:none; -} - -.NavBarFont1Rev -{ - -} - -.NavBarCell2 -{ - border:none; -} - -.NavBarCell2 a -{ - color:#249901; - font-size:90%; -} - -.NavBarCell3 -{ - border:none; -} - -/* Override sizes in font tags */ -font -{ - font: inherit !important; -}