20100409

Javadoc

I just put Perceptron up on bitbucket, and wanted to start documenting the code. Javadoc was able to generate reasonable looking documentation from what little comments were in the project, but I wasn't quite satisfied with the appearance of the rendered web-pages. So, I made a custom style sheet and ran a few commands to do some minor re-formatting.

I rather like the resulting format.

  • Style sheet hides redundant information in the member details section ( uses member type+name as title
  • Thin table edges
  • Script creates centered frame
  • I like these colors
  • Script removes empty vertical whitespace for members without documentation



  1 /* Javadoc style sheet 
2 * Revised by Michael Rule
3 * April 2010
4 * This is the sexiest Javadoc style sheet ever
5 */

6
7 body{
8 height:100%;
9 font-size: 95%;
10 background-color: #fff;
11 color:#403818
12 background-image: url("http://img.photobucket.com/albums/v234/MRule7404/frac5.jpg");
13 background-repeat: repeat-y;
14 background-attachment:
15 fixed;
16 }
17
18 /* You'll need to use some sort of text replacement to automatically insert <div> tages for
these wrappers within the body of your website */

19
20 #outer_wrapper {
21 height: 100%;
22 max-width: 870px;
23 min-width: 500px;
24 margin: 0 auto;
25 border-style: solid;
26 border-color: #ccc;
27 border-width: 1px;
28 border-radius: 8px;
29 -webkit-border-radius: 8px;
30 -moz-border-radius: 8px;
31 }
32
33 #inner_wrapper {
34 height:100%;
35 width:auto;
36 padding: 10px ;
37 border-style: solid;
38 border-color: #888;
39 border-width: 1px;
40 background : #ffffff;
41 line-height:1.4em;
42 border-radius: 7px;
43 -webkit-border-radius: 7px;
44 -moz-border-radius: 7px;
45 }
46
47 /* Headings */
48 h1 {
49 font-size: 70%
50 }
51
52 /* Table colors */
53 .TableHeadingColor { background: #ddd; color:#403818 }
54 .TableSubHeadingColor { background: #ccc; color:#605020 }
55 .TableRowColor { background: #eee; color:#000000 }
56
57 /* Font used in left-hand frame lists */
58 .FrameTitleFont { font-size: 80%; font-family: Helvetica, Arial, sans-serif; color:#403818 }
59 .FrameHeadingFont { font-size: 75%; font-family: Helvetica, Arial, sans-serif; color:#403818 }
60 .FrameItemFont { font-size: 75%; font-family: Helvetica, Arial, sans-serif; color:#403818 }
61
62 /* Navigation bar fonts and colors */
63 .NavBarCell1 { padding:0px 4px; background-color:#efd; color:#000000} /* Light mauve */
64 .NavBarCell1Rev { padding:0px 4px; background-color:#777; color:#000} /* Dark Blue */
65 .NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000;}
66 .NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#fff;}
67
68 .NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
69 .NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
70
71 a {
72 color: #134;
73 text-decoration: none;
74 }
75 a:hover {
76 color: #008;
77 text-decoration: underline;
78 }
79 a:active {
80 color: #008;
81 text-decoration: none;
82 }
83 a:visited {
84 color: #552;
85 text-decoration: none;
86 }
87
88 table {
89 border-collapse:collapse;
90 border-color:#ccc;
91 margin: 0px 0px 0px 0px;
92 padding: 150px;
93 }
94
95 TR{
96 margin: auto;
97 }
98
99 TD{
100 line-height:1.2em;
101 }
102
103 HR{
104 border: none;
105 height: 1px;
106 background: #aa8;
107 }
108
109 H3{
110 display:none;
111 }

No comments:

Post a Comment