[hamradio-commits] [gnss-sdr] 33/80: Adding caption and Doxygen path

[Carles Fernandez]

This is an automated email from the git hooks/post-receive script.

carles_fernandez-guest pushed a commit to branch upstream
in repository gnss-sdr.

commit f3f2e9458b5368d686afb485d52f6e47ca302ef8
Author: Carles Fernandez <carles.fernandez at gmail.com>
Date:   Thu May 5 20:36:22 2016 +0200

    Adding caption and Doxygen path
---
 src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/Doxyfile.in | 2 +-
 src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md   | 7 +++----
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/Doxyfile.in b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/Doxyfile.in
index c4770c5..bf566c5 100644
--- a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/Doxyfile.in
+++ b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/Doxyfile.in
@@ -885,7 +885,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @PROJECT_SOURCE_DIR@/docs/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
index e178a27..c7b520f 100644
--- a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
+++ b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
@@ -1,12 +1,12 @@
 # Welcome to VOLK_GNSSSDR, the Vector-Optimized Library of Kernels for GNSS-SDR
 
-VOLK_GNSSSDR is a sub-project of GNSS-SDR. This library provides a set of extra kernels that can be used stand-alone or in combination with VOLK's. Please see http://libvolk.org for documentation, source code, and contact information about the original VOLK.
+VOLK_GNSSSDR is a sub-project of GNSS-SDR. This library provides a set of extra kernels that can be used stand-alone or in combination with VOLK's. Please see http://libvolk.org for documentation, source code, and contact information about the original VOLK library.
 
 The boilerplate of this code was initially generated with ```volk_modtool```, an application provided by VOLK that creates the skeleton than can then be filled with custom kernels. Some modifications were added to accomodate the specificities of Global Navigation Satellite Systems (GNSS) signal processing. Those changes are clearly indicated in the source code, and do not break compatibility.
 
 This library contains kernels of hand-written SIMD code for different mathematical operations, mainly with 8-bit and 16-bit real and complex data types, offering a platform/architecture agnostic version that will run in all machines, plus other versions for different SIMD instruction sets. Then, the application ```volk_gnsssdr_profile``` runs some iterations of all versions that your machine can execute and annotates which is the fastest, which will then be selected at runtime when execu [...]
 
-These kernels have some specific features (e.g. saturation arithmetics) that are aimed to GNSS signal processing, but could make them not suitable for its general use in other applications. Check out the *generic* (that is, plain C) implementation to see what each kernel is actually doing.
+These kernels have some specific features (e.g. saturation arithmetics) that are aimed to GNSS signal processing, but could make them not suitable for its general use in other applications. Check out the documentation generated by Doxygen and the *generic* (that is, plain C) implementation to see what each kernel is actually doing.
 
 ## How to use VOLK_GNSSSDR:
 
@@ -42,8 +42,7 @@ From now on, GNSS-SDR (and any other program of your own that makes use of VOLK_
 
 This figure shows the role of some VOLK_GNSSSDR kernels in the context of a GNSS baseband processor:
 
-![](./docs/images/VOLK_GNSSSDR_Usage_Example.png)
-
+![Example of VOLK_GNSSSDR usage.](./docs/images/VOLK_GNSSSDR_Usage_Example.png)
 
 
 If you use VOLK_GNSSSDR in your research and/or software, please cite the following paper:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/gnss-sdr.git