Peter M. Groen / openbr

Commit 60f7944f349a338b752d0f480871c88108b058c9

Authored by Josh Klontz
1 parent ee8fbc89

updated documentation

Inline Side-by-side
Showing 2 changed files with 165 additions and 247 deletions
openbr/openbr.h
  View file @60f7944
... ... @@ -187,7 +187,6 @@ BR_EXPORT void br_finalize();
187 187 * \brief Perform score level fusion on similarity matrices.
188 188 * \param num_input_simmats Size of \em input_simmats.
189 189 * \param input_simmats Array of \ref simmat. All simmats must have the same dimensions.
190   - * \param mask \ref mask used to indicate which, if any, values to ignore.
191 190 * \param normalization Valid options are:
192 191 * - \c None - No score normalization.
193 192 * - \c MinMax - Scores normalized to [0,1].
... ...
openbr/openbr_export.cpp
  View file @60f7944
... ... @@ -57,9 +57,8 @@
57 57 * Installation from source is the recommended method for getting OpenBR on your machine.
58 58 * If you need a little help getting started, choose from the list of build instructions for free C++ compilers below:
59 59 * - \subpage windows_msvc
60   - * - \subpage windows_mingw
61 60 * - \subpage osx_clang
62   - * - \subpage linux_all
  61 + * - \subpage linux_gcc
63 62 *
64 63 * \section installation_from_binary From Binary
65 64 * Pre-compiled releases are not currently provided, but they can be built from source using the instructions above.
... ... @@ -96,50 +95,50 @@ $ br -help
96 95 * -# You will have to register with Microsoft after installation, but it's free.
97 96 * -# Grab any available <a href="http://www.microsoft.com/visualstudio/eng/downloads#d-visual-studio-2012-update">Visual Studio Updates</a>.
98 97 * -# Download and install <a href="http://msdn.microsoft.com/en-us/windows/hardware/hh852363.aspx">Windows 8 SDK</a>.
99   - * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.10.2-win32-x86.exe">Download and Install CMake 2.8.10.2</a>
  98 + * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2-win32-x86.exe">Download and Install CMake 2.8.11.2</a>
100 99 * -# During installation setup select "add CMake to PATH".
101   - * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>
  100 + * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a>
102 101 * -# Consider the free open source program <a href="http://www.7-zip.org/">7-Zip</a> if you need a program to unarchive tarballs.
103   - * -# Move the "opencv-2.4.5" folder to "C:\".
  102 + * -# Move the "opencv-2.4.6.1" folder to "C:\".
104 103 * -# Open "VS2012 x64 Cross Tools Command Prompt" (from the Start Menu, select "All Programs" -> "Microsoft Visual Studio 2012" -> "Visual Studio Tools" -> "VS2012 x64 Cross Tools Command Prompt") and enter:
105   - * \code
106   - * $ cd C:\opencv-2.4.5
107   - * $ mkdir build-msvc2012
108   - * $ cd build-msvc2012
109   - * $ cmake -G "NMake Makefiles" -DBUILD_PERF_TESTS=OFF -DBUILD_TESTS=OFF -DWITH_FFMPEG=OFF -DCMAKE_BUILD_TYPE=Debug ..
110   - * $ nmake
111   - * $ nmake install
112   - * $ cmake -DCMAKE_BUILD_TYPE=Release ..
113   - * $ nmake
114   - * $ nmake install
115   - * $ nmake clean
116   - * \endcode
117   - * -# <a href="http://download.qt-project.org/official_releases/qt/5.0/5.0.2/qt-windows-opensource-5.0.2-msvc2012_64-x64-offline.exe">Download and Install Qt 5.0.2</a>
  104 + \code
  105 + $ cd C:\opencv-2.4.6.1
  106 + $ mkdir build-msvc2012
  107 + $ cd build-msvc2012
  108 + $ cmake -G "NMake Makefiles" -DBUILD_PERF_TESTS=OFF -DBUILD_TESTS=OFF -DWITH_FFMPEG=OFF -DCMAKE_BUILD_TYPE=Debug ..
  109 + $ nmake
  110 + $ nmake install
  111 + $ cmake -DCMAKE_BUILD_TYPE=Release ..
  112 + $ nmake
  113 + $ nmake install
  114 + $ nmake clean
  115 + \endcode
  116 + * -# <a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-windows-opensource-5.1.1-msvc2012-x86_64-offline.exe">Download and Install Qt 5.1.1</a>
118 117 * -# Create a <a href="github.com">GitHub</a> account and follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
119 118 * -# Launch "Git Bash" from the Desktop and clone OpenBR:
120   - * \code
121   - * $ cd /c
122   - * $ git clone https://github.com/biometrics/openbr.git
123   - * $ cd openbr
124   - * $ git submodule init
125   - * $ git submodule update
126   - * \endcode
  119 + \code
  120 + $ cd /c
  121 + $ git clone https://github.com/biometrics/openbr.git
  122 + $ cd openbr
  123 + $ git submodule init
  124 + $ git submodule update
  125 + \endcode
127 126 * -# Build OpenBR!
128 127 * -# From the VS2012 x64 Cross Tools Command Prompt:
129   - * \code
130   - * $ cd C:\openbr
131   - * $ mkdir build-msvc2012
132   - * $ cd build-msvc2012
133   - * $ cmake -G "CodeBlocks - NMake Makefiles" -DCMAKE_PREFIX_PATH="C:/openCV-2.4.5/build-msvc2012/install;C:/Qt/Qt5.0.2/5.0.2/msvc2012_64" -DCMAKE_INSTALL_PREFIX="./install" -DBR_INSTALL_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release ..
134   - * $ nmake
135   - * $ nmake install
136   - * \endcode
  128 + \code
  129 + $ cd C:\openbr
  130 + $ mkdir build-msvc2012
  131 + $ cd build-msvc2012
  132 + $ cmake -G "CodeBlocks - NMake Makefiles" -DCMAKE_PREFIX_PATH="C:/opencv-2.4.6.1/build-msvc2012/install;C:/Qt/Qt5.1.1/5.1.1/msvc2012_64" -DCMAKE_INSTALL_PREFIX="./install" -DBR_INSTALL_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release ..
  133 + $ nmake
  134 + $ nmake install
  135 + \endcode
137 136 * -# Check out the "install" folder.
138 137 * -# Hack OpenBR!
139 138 * -# From the VS2012 x64 Cross Tools Command Prompt:
140   - * \code
141   - * $ C:\Qt\Qt5.0.2\Tools\QtCreator\bin\qtcreator.exe
142   - * \endcode
  139 + \code
  140 + $ C:\Qt\Qt5.1.1\Tools\QtCreator\bin\qtcreator.exe
  141 + \endcode
143 142 * -# From the Qt Creator "Tools" menu select "Options..."
144 143 * -# Under "Kits" select "Desktop (default)"
145 144 * -# For "Compiler:" select "Microsoft Visual C++ Compiler 11.0 (x86_amd64)" and click "OK"
... ... @@ -151,258 +150,178 @@ $ br -help
151 150 * -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
152 151 * -# (Optional) Package OpenBR!
153 152 * -# From the VS2012 x64 Cross Tools Command Prompt:
154   - * \code
155   - * $ cd C:\openbr\build-msvc2012
156   - * $ cpack -G ZIP
157   - * \endcode
158   - */
159   -
160   -/*!
161   - * \page windows_mingw Windows 7 - MinGW-w64 2.0 - x64
162   - * -# <a href="http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/rubenvb/gcc-4.7-release/x86_64-w64-mingw32-gcc-4.7.2-release-win64_rubenvb.7z/download">Download and Unarchive MinGW-w64 GCC 4.7.2</a>
163   - * -# Use the free open source program <a href="http://www.7-zip.org/">7-Zip</a> to unarchive.
164   - * -# Move "x86_64-w64-mingw32-gcc-4.7.2-release-win64_rubenvb\mingw64" to "C:\".
165   - * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.10.2-win32-x86.exe">Download and Install CMake 2.8.10.2</a>
166   - * -# During installation setup select "add CMake to PATH".
167   - * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>
168   - * -# Consider the free open source program <a href="http://www.7-zip.org/">7-Zip</a> if you need a program to unarchive tarballs.
169   - * -# Move the "opencv-2.4.5" folder to "C:\".
170   - * -# From the MinGW-w64 Command Prompt (double-click "C:\mingw64\mingw64env.cmd"):
171   - * \code
172   - * $ cd C:\opencv-2.4.5
173   - * $ mkdir build-mingw64
174   - * $ cd build-mingw64
175   - * $ cmake -G "MinGW Makefiles" -DBUILD_PERF_TESTS=OFF -DBUILD_TESTS=OFF -DWITH_FFMPEG=OFF -DCMAKE_BUILD_TYPE=Debug ..
176   - * $ mingw32-make
177   - * $ mingw32-make install
178   - * $ cmake -DCMAKE_BUILD_TYPE=Release ..
179   - * $ mingw32-make
180   - * $ mingw32-make install
181   - * $ mingw32-make clean
182   - * \endcode
183   - * -# <a href="http://download.qt-project.org/official_releases/qt/5.0/5.0.2/single/qt-everywhere-opensource-src-5.0.2.zip">Download and Unzip Qt 5.0.2</a>
184   - * -# Install Perl/Python/Ruby dependencies as explained in the "Windows" section of "README". Make sure they are added to "path" when given the option during installation.
185   - * -# <a href="http://www.microsoft.com/en-us/download/confirmation.aspx?id=6812">Download and Install Direct X Software Developement Kit</a>, you may also need to install the latest OpenGL drivers from your graphics card manufacturer.
186   - * -# From the MinGW-w64 Command Prompt:
187   - * \code
188   - * $ cd qt-everywhere-opensource-src-5.0.2
189   - * $ configure -prefix C:\Qt\Qt5.0.2\5.0.2\mingw64 -opensource -confirm-license -nomake examples -nomake tests -opengl desktop
190   - * $ mingw32-make
191   - * $ mingw32-make install
192   - * $ cd ..
193   - * $ rmdir /Q /S qt-everywhere-opensource-src-5.0.2
194   - * \endcode
195   - * -# mingw32-make will take several hours to finish.
196   - * -# Create a <a href="github.com">GitHub</a> account and follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
197   - * -# Launch "Git Bash" from the Desktop and clone OpenBR:
198   - * \code
199   - * $ cd /c
200   - * $ git clone https://github.com/biometrics/openbr.git
201   - * $ cd openbr
202   - * $ git submodule init
203   - * $ git submodule update
204   - * \endcode
205   - * -# Build OpenBR!
206   - * -# From the MinGW-w64 Command Prompt:
207   - * \code
208   - * $ cd C:\openbr
209   - * $ mkdir build-mingw64
210   - * $ cd build-mingw64
211   - * $ cmake -G "CodeBlocks - MinGW Makefiles" -DCMAKE_RC_COMPILER="C:/mingw64/bin/windres.exe" -DCMAKE_PREFIX_PATH="C:/opencv-2.4.5/build-mingw64/install;C:/Qt/Qt5.0.2/5.0.2/mingw64" -DCMAKE_INSTALL_PREFIX="./install" -DBR_INSTALL_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release ..
212   - * $ mingw32-make
213   - * $ mingw32-make install
214   - * \endcode
215   - * -# Check out the "install" folder.
216   - * -# Hack OpenBR!
217   - * -# From the MinGW-w64 Command Prompt:
218   - * \code
219   - * $ C:\Qt\Qt5.0.2\Tools\QtCreator\bin\qtcreator.exe
220   - * \endcode
221   - * -# From the Qt Creator "Tools" menu select "Options..."
222   - * -# Under "Kits" select "Desktop (default)"
223   - * -# For "Compiler:" select "MinGW (x86 64bit in C:\mingw64\bin)" and click "OK"
224   - * -# From the Qt Creator "File" menu select "Open File or Project...".
225   - * -# Select "C:\openbr\CMakeLists.txt" then "Open".
226   - * -# If prompted for the location of CMake, enter "C:\Program Files (x86)\CMake 2.8\bin\cmake.exe".
227   - * -# Browse to your pre-existing build directory "C:\openbr\build-mingw64" then select "Next".
228   - * -# Clear any text in the "arguments" box then select "Run CMake" then "Finish".
229   - * -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
230   - * -# (Optional) Package OpenBR!
231   - * -# From the MinGW-w64 Command Prompt:
232   - * \code
233   - * $ cd C:\openbr\build-mingw64
234   - * $ cpack -G ZIP
235   - * \endcode
  153 + \code
  154 + $ cd C:\openbr\build-msvc2012
  155 + $ cpack -G ZIP
  156 + \endcode
236 157 */
237 158  
238 159 /*!
239 160 * \page osx_clang OS X Mountain Lion - Clang/LLVM 3.1 - x64
240 161 * -# Download and install the latest "Xcode" and "Command Line Tools" from the <a href="https://developer.apple.com/downloads/index.action#">Apple Developer Downloads</a> page.
241   - * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.10.2.tar.gz">Download CMake 2.8.10.2</a>
242   - * \code
243   - * $ cd ~/Downloads
244   - * $ tar -xf cmake-2.8.10.2.tar.gz
245   - * $ cd cmake-2.8.10.2
246   - * $ ./configure
247   - * $ make -j4
248   - * $ sudo make install
249   - * $ cd ..
250   - * $ rm -rf cmake-2.8.10.2*
251   - * \endcode
252   - * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>
253   - * \code
254   - * $ cd ~/Downloads
255   - * $ tar -xf opencv-2.4.5.tar.gz
256   - * $ cd opencv-2.4.5
257   - * $ mkdir build
258   - * $ cd build
259   - * $ cmake -DCMAKE_BUILD_TYPE=Release ..
260   - * $ make -j4
261   - * $ sudo make install
262   - * $ cd ../..
263   - * $ rm -rf opencv-2.4.5*
264   - * \endcode
265   - * -# <a href="http://download.qt-project.org/official_releases/qt/5.0/5.0.2/qt-mac-opensource-5.0.2-clang-offline.dmg">Download and install Qt 5.0.2</a>
  162 + * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2.tar.gz">Download CMake 2.8.11.2</a>
  163 + \code
  164 + $ cd ~/Downloads
  165 + $ tar -xf cmake-2.8.11.2.tar.gz
  166 + $ cd cmake-2.8.11.2
  167 + $ ./configure
  168 + $ make -j4
  169 + $ sudo make install
  170 + $ cd ..
  171 + $ rm -rf cmake-2.8.11.2*
  172 + \endcode
  173 + * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a>
  174 + \code
  175 + $ cd ~/Downloads
  176 + $ tar -xf opencv-2.4.6.1.tar.gz
  177 + $ cd opencv-2.4.6.1
  178 + $ mkdir build
  179 + $ cd build
  180 + $ cmake -DCMAKE_BUILD_TYPE=Release ..
  181 + $ make -j4
  182 + $ sudo make install
  183 + $ cd ../..
  184 + $ rm -rf opencv-2.4.6.1*
  185 + \endcode
  186 + * -# <a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-mac-opensource-5.1.1-clang-offline.dmg">Download and install Qt 5.1.1</a>
266 187 * -# Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
267   - * \code
268   - * $ git clone https://github.com/biometrics/openbr.git
269   - * $ cd openbr
270   - * $ git submodule init
271   - * $ git submodule update
272   - * \endcode
  188 + \code
  189 + $ git clone https://github.com/biometrics/openbr.git
  190 + $ cd openbr
  191 + $ git submodule init
  192 + $ git submodule update
  193 + \endcode
273 194 * -# Build OpenBR!
274   - * \code
275   - * $ mkdir build # from the OpenBR root directory
276   - * $ cd build
277   - * $ cmake -DCMAKE_PREFIX_PATH=~/Qt5.0.2/5.0.2/clang_64 -DCMAKE_BUILD_TYPE=Release ..
278   - * $ make -j4
279   - * $ sudo make install
280   - * \endcode
  195 + \code
  196 + $ mkdir build # from the OpenBR root directory
  197 + $ cd build
  198 + $ cmake -DCMAKE_PREFIX_PATH=~/Qt5.1.1/5.1.1/clang_64 -DCMAKE_BUILD_TYPE=Release ..
  199 + $ make -j4
  200 + $ sudo make install
  201 + \endcode
281 202 * -# Hack OpenBR!
282 203 * -# Open Qt Creator IDE
283   - * \code
284   - * $ open ~/Qt5.0.2/Qt\ Creator.app
285   - * \endcode
  204 + \code
  205 + $ open ~/Qt5.1.1/Qt\ Creator.app
  206 + \endcode
286 207 * -# From the Qt Creator "File" menu select "Open File or Project...".
287 208 * -# Select "openbr/CMakeLists.txt" then "Open".
288 209 * -# Browse to your pre-existing build directory "openbr/build" then select "Continue".
289 210 * -# Select "Run CMake" then "Done".
290 211 * -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
291 212 * -# (Optional) Test OpenBR!
292   - * \code
293   - * $ cd openbr/scripts
294   - * $ ./downloadDatasets.sh
295   - * $ cd ../build
296   - * $ make test
297   - * \endcode
  213 + \code
  214 + $ cd openbr/scripts
  215 + $ ./downloadDatasets.sh
  216 + $ cd ../build
  217 + $ make test
  218 + \endcode
298 219 * -# (Optional) Package OpenBR!
299   - * \code
300   - * $ cd openbr/build
301   - * $ sudo cpack -G TGZ
302   - * \endcode
  220 + \code
  221 + $ cd openbr/build
  222 + $ sudo cpack -G TGZ
  223 + \endcode
303 224 * -# (Optional) Build OpenBR documentation!
304   - * -# <a href="ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.2.src.tar.gz">Download Doxygen 1.8.2</a>
305   - * \code
306   - * $ cd ~/Downloads
307   - * $ tar -xf doxygen-1.8.2.src.tar.gz
308   - * $ cd doxygen-1.8.2
309   - * $ ./configure
310   - * $ make -j4
311   - * $ sudo make install
312   - * $ cd ..
313   - * $ rm -rf doxygen-1.8.2*
314   - * \endcode
  225 + * -# <a href="ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.5.src.tar.gz">Download Doxygen 1.8.5</a>
  226 + \code
  227 + $ cd ~/Downloads
  228 + $ tar -xf doxygen-1.8.5.src.tar.gz
  229 + $ cd doxygen-1.8.5
  230 + $ ./configure
  231 + $ make -j4
  232 + $ sudo make install
  233 + $ cd ..
  234 + $ rm -rf doxygen-1.8.5*
  235 + \endcode
315 236 * -# Modify build settings and recompile.
316   - * \code
317   - * $ cd openbr/build
318   - * $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
319   - * $ make -j4
320   - * $ open html/index.html
321   - * \endcode
  237 + \code
  238 + $ cd openbr/build
  239 + $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
  240 + $ make -j4
  241 + $ open html/index.html
  242 + \endcode
322 243 */
323 244  
324 245 /*!
325   - * \page linux_all Ubuntu 13.04 - GCC 4.7.3 or ICC 13.1.1 - x64
  246 + * \page linux_gcc Ubuntu 13.04 - GCC 4.7.3 - x64
326 247 * -# Install GCC 4.7.3
327   - * \code
328   - * $ sudo apt-get update
329   - * $ sudo apt-get install build-essential
330   - * \endcode
331   - * -# (Optional) Assuming you meet the eligibility requirements and you want to use ICC instead of GCC, <a href="http://software.intel.com/en-us/non-commercial-software-development">Download and Install Intel C++ Studio XE 2013</a>.
  248 + \code
  249 + $ sudo apt-get update
  250 + $ sudo apt-get install build-essential
  251 + \endcode
332 252 * -# Install CMake 2.8.10.1
333   - * \code
334   - * $ sudo apt-get install cmake cmake-curses-gui
335   - * \endcode
  253 + \code
  254 + $ sudo apt-get install cmake cmake-curses-gui
  255 + \endcode
336 256 * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>, note <a href="https://github.com/biometrics/openbr/wiki/Build-OpenCV-with-Video-Support-on-Ubuntu">this</a>
337   - * \code
338   - * $ cd ~/Downloads
339   - * $ tar -xf opencv-2.4.5.tar.gz
340   - * $ cd opencv-2.4.5
341   - * $ mkdir build
342   - * $ cd build
343   - * $ cmake -DCMAKE_BUILD_TYPE=Release ..
344   - * $ make -j4
345   - * $ sudo make install
346   - * $ cd ../..
347   - * $ rm -rf opencv-2.4.5*
348   - * \endcode
  257 + \code
  258 + $ cd ~/Downloads
  259 + $ tar -xf opencv-2.4.5.tar.gz
  260 + $ cd opencv-2.4.5
  261 + $ mkdir build
  262 + $ cd build
  263 + $ cmake -DCMAKE_BUILD_TYPE=Release ..
  264 + $ make -j4
  265 + $ sudo make install
  266 + $ cd ../..
  267 + $ rm -rf opencv-2.4.5*
  268 + \endcode
349 269 * -# Install Qt 5.0.1
350   - * \code
351   - * $ sudo apt-get install qt5-default libqt5svg5-dev qtcreator
352   - * \endcode
  270 + \code
  271 + $ sudo apt-get install qt5-default libqt5svg5-dev qtcreator
  272 + \endcode
353 273 * -# Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
354   - * \code
355   - * $ git clone https://github.com/biometrics/openbr.git
356   - * $ cd openbr
357   - * $ git submodule init
358   - * $ git submodule update
359   - * \endcode
  274 + \code
  275 + $ git clone https://github.com/biometrics/openbr.git
  276 + $ cd openbr
  277 + $ git submodule init
  278 + $ git submodule update
  279 + \endcode
360 280 * -# Build OpenBR!
361   - * \code
362   - * $ mkdir build # from the OpenBR root directory
363   - * $ cd build
364   - * $ cmake -DCMAKE_BUILD_TYPE=Release .. # GCC Only
365   - * $ cmake -DCMAKE_C_COMPILER=/opt/intel/bin/icc -DCMAKE_CXX_COMPILER=/opt/intel/bin/icpc -DCMAKE_BUILD_TYPE=Release .. # ICC Only
366   - * $ make -j4
367   - * $ sudo make install
368   - * \endcode
  281 + \code
  282 + $ mkdir build # from the OpenBR root directory
  283 + $ cd build
  284 + $ cmake -DCMAKE_BUILD_TYPE=Release ..
  285 + $ make -j4
  286 + $ sudo make install
  287 + \endcode
369 288 * -# Hack OpenBR!
370 289 * -# Open Qt Creator IDE
371   - * \code
372   - * $ qtcreator &
373   - * \endcode
  290 + \code
  291 + $ qtcreator &
  292 + \endcode
374 293 * -# From the Qt Creator "File" menu select "Open File or Project...".
375 294 * -# Select "openbr/CMakeLists.txt" then "Open".
376 295 * -# Browse to your pre-existing build directory "openbr/build" then select "Next".
377 296 * -# Select "Run CMake" then "Finish".
378 297 * -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
379 298 * -# (Optional) Test OpenBR!
380   - * \code
381   - * $ cd openbr/scripts
382   - * $ ./downloadDatasets.sh
383   - * $ cd ../build
384   - * $ make test
385   - * \endcode
  299 + \code
  300 + $ cd openbr/scripts
  301 + $ ./downloadDatasets.sh
  302 + $ cd ../build
  303 + $ make test
  304 + \endcode
386 305 * -# (Optional) Package OpenBR!
387   - * \code
388   - * $ cd openbr/build
389   - * $ sudo cpack -G TGZ
390   - * \endcode
  306 + \code
  307 + $ cd openbr/build
  308 + $ sudo cpack -G TGZ
  309 + \endcode
391 310 * -# (Optional) Build OpenBR documentation!
392   - * \code
393   - * $ sudo apt-get install doxygen
394   - * $ cd openbr/build
395   - * $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
396   - * $ make -j4
397   - * $ sudo apt-get install libgnome2-bin
398   - * $ gnome-open html/index.html
399   - * \endcode
  311 + \code
  312 + $ sudo apt-get install doxygen
  313 + $ cd openbr/build
  314 + $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
  315 + $ make -j4
  316 + $ sudo apt-get install libgnome2-bin
  317 + $ gnome-open html/index.html
  318 + \endcode
400 319 */
401 320  
402 321 /*!
403 322 * \page help Help
404 323 * - Developer mailing list: <a href="https://groups.google.com/forum/?fromgroups#!forum/openbr-dev">openbr-dev@googlegroups.com</a>
405   - * - IRC Channel: <a href="http://webchat.freenode.net/">irc.freenode.net#openbr</a>
  324 + * - IRC Channel: <a href="http://webchat.freenode.net/?channels=openbr">irc.freenode.net\#openbr</a>
406 325 */
407 326  
408 327 /*!
... ...