mirrors
/
gnss-sdr
mirror of https://github.com/gnss-sdr/gnss-sdr
1
0
Fork 0
Code Issues Releases Wiki Activity

Adding documentation about the CMake targets 'make pdfmanual' and 'make doc-clean' 

git-svn-id: https://svn.code.sf.net/p/gnss-sdr/code/trunk@318 64b25241-fba3-4117-9849-534c7e92360d
This commit is contained in:
Carles Fernandez 2013-01-18 14:46:18 +00:00
parent bb8cd35f66
commit 8dbed61e2f
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/doxygen/other/main_page.dox
View File

@ -165,6 +165,17 @@ $ make doc
from the <tt>gnss-sdr/build</tt> folder if you are using CMake. In both cases, <a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">Doxygen</a> will generate HTML documentation that can be
retrieved pointing your browser of preference to <tt>gnss-sdr/docs/html/index.html</tt>.
If you are using CMake, there are two more extra targets available. From the <tt>gnss-sdr/build</tt> folder:
\code
$ make doc-clean
\endcode
will remove the content of previously-generated documentation and, if a LaTeX installation is detected in your system,
\code
$ make pdfmanual
\endcode
will create a PDF manual at <tt>gnss-sdr/docs/GNSS-SDR_manual.pdf</tt>.
\subsection debug_and_release Debug and Release builds
By default, CMake will build the Release version, meaning that the compiler will generate a faster, optimized executable. This is the recommended build type when using