-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
howto.html
executable file
·114 lines (108 loc) · 5.29 KB
/
howto.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<meta name="description" content="">
<meta name="author" content="">
<link rel="icon" href="favicon.ico">
<title>Javadoc Themer</title>
<!-- Bootstrap core CSS -->
<link href="dist/css/bootstrap.min.css" rel="stylesheet">
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<link href="dist/css/ie10-viewport-bug-workaround.css" rel="stylesheet">
<!-- Custom styles for this template -->
<link href="base.css" rel="stylesheet">
<script src="dist/js/ie-emulation-modes-warning.js"></script>
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-53824796-9"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-53824796-9');
</script>
</head>
<body>
<div class="container">
<div class="header clearfix">
<nav>
<ul class="nav nav-pills pull-right">
<li role="presentation"><a href="index.html">Javadoc Themer</a></li>
<li role="presentation" class="active"><a href="#">How to</a></li>
<li role="presentation"><a href="https://github.com/nisrulz/javadoc-themer" target="_blank">Github</a></li>
</ul>
</nav>
<h3 class="text-muted"> <img src="dist/img/brush.png" style="height:1.1em;" /> How to</h3>
</div>
<div class="row">
<p>Javadoc Themer basically was written for android based projects hence the below steps (1-3 and 5) are for
IntelliJ/Android Studio IDE, but if you use a terminal then skip over to step 4 and just provide the
stylesheet as a commandline argument to generate the javadoc with the new stylesheet.</p>
<div class="col-lg-12">
<h4>Step 1</h4>
<p>
Well,basically write javadoc style comments in your java source code.
</p>
</div>
<div class="col-lg-12">
<h4>Step 2</h4>
<p>
<img src="dist/img/sc1.jpeg" />
<br/>
<br/> Goto <b>Tools > Generate Javadoc </b>
</p>
</div>
<div class="col-lg-12">
<h4>Step 3</h4>
<p>
<img src="dist/img/sc2.jpeg" />
<br/>
<br/> Setup a destination/output directory
</p>
</div>
<div class="col-lg-12">
<h4>Step 4</h4>
<p>
<img src="dist/img/sc3.jpeg" />
<br/>
<br/> Provide the required commandline arguments
<br/>
<b>
<pre> -encoding UTF-8 -docencoding utf-8 -charset utf-8 -stylesheetfile <location_of_generated_stylesheet>/javadoc_stylesheet.css </pre>
<i>Note: Replace <location_of_generated_stylesheet> with the correct path</i>
</b>
</p>
</div>
<div class="col-lg-12">
<h4>Step 5</h4>
<p>
And thats all, just hit <b>Ok</b> and you get the newly generated javadoc.
</p>
</div>
</div>
<br/>
<br/>
<h3>Checkout the difference..</h3>
<img src="img/javadocdiff.png" class="img-responsive" />
<br/>
<footer class="footer">
<p> Built by <a href="https://github.com/nisrulz" target="_blank">Nishant Srivastava</a> (..with lots of caffiene)</p>
<p>Uses <a href="https://mjolnic.com/bootstrap-colorpicker/" target="_blank">Colorpicker for Twitter Bootstrap</a> , <a href="https://getbootstrap.com/" target="_blank">Twitter Bootstrap</a> and <a href="http://lesscss.org/"
target="_blank">LessJS</a>
</p>
<p>© 2016 Nishant Srivastava</p>
</footer>
</div>
<!-- /container -->
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<script src="dist/js/ie10-viewport-bug-workaround.js"></script>
</body>
</html>