-
Notifications
You must be signed in to change notification settings - Fork 0
/
DoxygenSetup.html
267 lines (224 loc) · 9.62 KB
/
DoxygenSetup.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Doxygen Setup</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=fadd4351" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=77160d70" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="New Starter C++" href="NewStarterC%2B%2B.html" />
<link rel="prev" title="Documentation Testing" href="Testing/Documentation/DocumentationTest.html" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org">
</a>
<span class="navbar-text navbar-version pull-left"><b>main</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="index.html">Home</a></li>
<li><a href="https://download.mantidproject.org">Download</a></li>
<li><a href="https://docs.mantidproject.org">User Documentation</a></li>
<li><a href="http://www.mantidproject.org/contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Doxygen Setup</a></li>
</ul>
</div> </p>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<section id="doxygen-setup">
<h1>Doxygen Setup<a class="headerlink" href="#doxygen-setup" title="Link to this heading">¶</a></h1>
<section id="unix-console-doxygen-setup">
<h2>Unix Console Doxygen Setup<a class="headerlink" href="#unix-console-doxygen-setup" title="Link to this heading">¶</a></h2>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><div class="line-block">
<div class="line">Check for</div>
<div class="line">doxygen</div>
</div>
</td>
<td><p>You may well already have doxygen installed but is it most likely
in your systems repositories.
If not, build from source
<a class="reference external" href="http://www.stack.nl/~dimitri/doxygen/download.html#srcbin">here</a>.</p></td>
</tr>
<tr class="row-even"><td><p>Run cmake</p></td>
<td><p>CMake will genereate the doyxgen config file
in ${CMAKE_DIR}/Framework/Doxygen/Mantid.doxyfile</p></td>
</tr>
<tr class="row-odd"><td><div class="line-block">
<div class="line">You’re done!</div>
<div class="line">Try!</div>
</div>
</td>
<td><ul class="simple">
<li><p>Type ‘make doxygen’</p></li>
<li><p>This will run doxygen, showing the output in the console. You may
want to pipe warnings to a file to make them easy to read later:
‘make doxygen 2> doxygen_errors.log’</p></li>
<li><p>The documentation will go into a subdir doxygen/html of the
directory where cmake was run from.</p></li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section id="visual-studio-doxygen-setup">
<h2>Visual Studio Doxygen Setup<a class="headerlink" href="#visual-studio-doxygen-setup" title="Link to this heading">¶</a></h2>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p>Install doxygen
binaries</p></td>
<td><p>Download the
<a class="reference external" href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc">Windows binaries</a>
and install them. I’ll assume in the following you installed doxygen in
c:program filesdoxygen</p></td>
</tr>
<tr class="row-even"><td><p>Rerun CMake</p></td>
<td><p>Run cmake for the build to ensure that the Mantid.doxyfile is created</p></td>
</tr>
<tr class="row-odd"><td><p>Add VC++ Tool:
“DoxyGen”</p></td>
<td><ul class="simple">
<li><p>ToolsExternal Tool then click Add</p></li>
<li><p>Title: &DoxyGen</p></li>
<li><p>Command: C:Program FilesDoxygenbindoxygen.exe</p></li>
<li><p>Arguments: “$(SolutionDir)FrameworkDoxygenMantid.doxyfile” (include the quotes!)</p></li>
<li><p>Initial Directory: $(SolutionDir)Build</p></li>
<li><p>Check the “Use output window” box</p></li>
</ul>
</td>
</tr>
<tr class="row-even"><td><p>Add VC++ Tool:
“view DoxyGen”</p></td>
<td><ul class="simple">
<li><p>ToolsExternal Tool then click Add</p></li>
<li><p>Title: &View DoxyGen</p></li>
<li><p>Command your favorite browser, e.g. C:program Filesinternet Exploreriexplore.exe
or C:Program Files (x86)GoogleChromeApplicationchrome.exe</p></li>
<li><p>Arguments: “$(SolutionDir)doxygenhtmlindex.html”</p></li>
<li><p>Initial Directory: leave empty</p></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>You’re done!
Try! “DoxyGen”</p></td>
<td><ul class="simple">
<li><p>Choose Tools/DoxyGen from the menu, and watch the magic happen (DoxyGen will log
it’s progress and complaints to the output window). Clicking on a warning message
will take you to the location in the code of the warning.</p></li>
<li><p>Choose Tools/View DoxyGen to explore the documentation.</p></li>
<li><p>The “Main Page” is probably rather boring. Click on “Namespaces” in the menu line to
browse your classes etc.</p></li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section id="eclipse-doxygen-setup">
<h2>Eclipse Doxygen Setup<a class="headerlink" href="#eclipse-doxygen-setup" title="Link to this heading">¶</a></h2>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p>Check for
doxygen</p></td>
<td><p>You may well already have doxygen installed, but if not you can install it at the same
time as the plugin below via the update site</p></td>
</tr>
<tr class="row-even"><td><p>Run cmake</p></td>
<td><p>This will generate the doxygen config file in
${CMake_DIR}/Framework/Doxygen/Mantid.doxygen</p></td>
</tr>
<tr class="row-odd"><td><p>Install Eclipse
plugin: “Eclox”</p></td>
<td><ul class="simple">
<li><p><a class="reference external" href="http://eclox.eu/">Eclox</a> is a frontend plugin for Eclipse.</p></li>
<li><p>Install it using the Eclipse Update Manager</p></li>
<li><p>To do this go to Help -> Software Updates…</p></li>
<li><p>Select the ‘Available Software’ tab then the ‘Add Site…’ button</p></li>
<li><p>Enter <cite>http://download.gna.org/eclox/update</cite> as the location</p></li>
<li><p>Eclipse will add the site to the list and you can open the tree to select and install
Eclox</p></li>
</ul>
</td>
</tr>
<tr class="row-even"><td><p>You’re done!
Try!</p></td>
<td><ul class="simple">
<li><p>You’ll now have a ‘build doxygen’ button in your toolbar (a blue ‘@’)</p></li>
<li><p>The first time you click it you’ll be prompted for the configuration file. Point it
at ${CMake_DIR}/Framework/Doxygen/Mantid.doxygen</p></li>
<li><p>This will run doxygen, showing the output in the console and adding warnings symbols
on the source files (as for compilation warnings). Hovering over these will show the
warning.</p></li>
<li><p>The documentation will go into a subdir doxygen/html of the directory where cmake was
run from.</p></li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="Testing/Documentation/DocumentationTest.html" title="Previous Chapter: Documentation Testing"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Documentation Testing</span>
</a>
</li>
<li>
<a href="NewStarterC%2B%2B.html" title="Next Chapter: New Starter C++"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">New Starter C++ »</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>