mirror of
https://github.com/gnss-sdr/gnss-sdr
synced 2025-08-29 17:07:58 +00:00
Fix docs: add brief description in header to all files
This commit is contained in:
Carles Fernandez
@@ -1,50 +1,50 @@
|
|||||||
|
/*!
|
||||||
//
|
* \file clFFT.h
|
||||||
// File: clFFT.h
|
* \brief FFT in OpenCL
|
||||||
//
|
*
|
||||||
// Version: <1.0>
|
*
|
||||||
//
|
* Version: <1.0>
|
||||||
// Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
*
|
||||||
// in consideration of your agreement to the following terms, and your use,
|
* Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
||||||
// installation, modification or redistribution of this Apple software
|
* in consideration of your agreement to the following terms, and your use,
|
||||||
// constitutes acceptance of these terms. If you do not agree with these
|
* installation, modification or redistribution of this Apple software
|
||||||
// terms, please do not use, install, modify or redistribute this Apple
|
* constitutes acceptance of these terms. If you do not agree with these
|
||||||
// software.
|
* terms, please do not use, install, modify or redistribute this Apple
|
||||||
//
|
* software.
|
||||||
// In consideration of your agreement to abide by the following terms, and
|
*
|
||||||
// subject to these terms, Apple grants you a personal, non - exclusive
|
* In consideration of your agreement to abide by the following terms, and
|
||||||
// license, under Apple's copyrights in this original Apple software ( the
|
* subject to these terms, Apple grants you a personal, non - exclusive
|
||||||
// "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
* license, under Apple's copyrights in this original Apple software ( the
|
||||||
// Software, with or without modifications, in source and / or binary forms;
|
* "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
||||||
// provided that if you redistribute the Apple Software in its entirety and
|
* Software, with or without modifications, in source and / or binary forms;
|
||||||
// without modifications, you must retain this notice and the following text
|
* provided that if you redistribute the Apple Software in its entirety and
|
||||||
// and disclaimers in all such redistributions of the Apple Software. Neither
|
* without modifications, you must retain this notice and the following text
|
||||||
// the name, trademarks, service marks or logos of Apple Inc. may be used to
|
* and disclaimers in all such redistributions of the Apple Software. Neither
|
||||||
// endorse or promote products derived from the Apple Software without specific
|
* the name, trademarks, service marks or logos of Apple Inc. may be used to
|
||||||
// prior written permission from Apple. Except as expressly stated in this
|
* endorse or promote products derived from the Apple Software without specific
|
||||||
// notice, no other rights or licenses, express or implied, are granted by
|
* prior written permission from Apple. Except as expressly stated in this
|
||||||
// Apple herein, including but not limited to any patent rights that may be
|
* notice, no other rights or licenses, express or implied, are granted by
|
||||||
// infringed by your derivative works or by other works in which the Apple
|
* Apple herein, including but not limited to any patent rights that may be
|
||||||
// Software may be incorporated.
|
* infringed by your derivative works or by other works in which the Apple
|
||||||
//
|
* Software may be incorporated.
|
||||||
// The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
*
|
||||||
// WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
* The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
||||||
// WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
||||||
// PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
* WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
||||||
// ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
* PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
||||||
//
|
* ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
||||||
// IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
*
|
||||||
// CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
||||||
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
// INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
// AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
* INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
||||||
// UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
* AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
||||||
// OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
* UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
||||||
//
|
* OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
// Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
*
|
||||||
//
|
* Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
||||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef __CLFFT_H
|
#ifndef __CLFFT_H
|
||||||
#define __CLFFT_H
|
#define __CLFFT_H
|
||||||
|
|||||||
@@ -1,49 +1,50 @@
|
|||||||
|
/*!
|
||||||
//
|
* \file fft_base_kernels.h
|
||||||
// File: fft_base_kernels.h
|
* \brief FFT base kernels for OpenCL
|
||||||
//
|
*
|
||||||
// Version: <1.0>
|
*
|
||||||
//
|
* Version: <1.0>
|
||||||
// Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
*
|
||||||
// in consideration of your agreement to the following terms, and your use,
|
* Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
||||||
// installation, modification or redistribution of this Apple software
|
* in consideration of your agreement to the following terms, and your use,
|
||||||
// constitutes acceptance of these terms. If you do not agree with these
|
* installation, modification or redistribution of this Apple software
|
||||||
// terms, please do not use, install, modify or redistribute this Apple
|
* constitutes acceptance of these terms. If you do not agree with these
|
||||||
// software.
|
* terms, please do not use, install, modify or redistribute this Apple
|
||||||
//
|
* software.¬
|
||||||
// In consideration of your agreement to abide by the following terms, and
|
*
|
||||||
// subject to these terms, Apple grants you a personal, non - exclusive
|
* In consideration of your agreement to abide by the following terms, and
|
||||||
// license, under Apple's copyrights in this original Apple software ( the
|
* subject to these terms, Apple grants you a personal, non - exclusive
|
||||||
// "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
* license, under Apple's copyrights in this original Apple software ( the
|
||||||
// Software, with or without modifications, in source and / or binary forms;
|
* "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
||||||
// provided that if you redistribute the Apple Software in its entirety and
|
* Software, with or without modifications, in source and / or binary forms;
|
||||||
// without modifications, you must retain this notice and the following text
|
* provided that if you redistribute the Apple Software in its entirety and
|
||||||
// and disclaimers in all such redistributions of the Apple Software. Neither
|
* without modifications, you must retain this notice and the following text
|
||||||
// the name, trademarks, service marks or logos of Apple Inc. may be used to
|
* and disclaimers in all such redistributions of the Apple Software. Neither
|
||||||
// endorse or promote products derived from the Apple Software without specific
|
* the name, trademarks, service marks or logos of Apple Inc. may be used to
|
||||||
// prior written permission from Apple. Except as expressly stated in this
|
* endorse or promote products derived from the Apple Software without specific
|
||||||
// notice, no other rights or licenses, express or implied, are granted by
|
* prior written permission from Apple. Except as expressly stated in this
|
||||||
// Apple herein, including but not limited to any patent rights that may be
|
* notice, no other rights or licenses, express or implied, are granted by
|
||||||
// infringed by your derivative works or by other works in which the Apple
|
* Apple herein, including but not limited to any patent rights that may be
|
||||||
// Software may be incorporated.
|
* infringed by your derivative works or by other works in which the Apple
|
||||||
//
|
* Software may be incorporated.
|
||||||
// The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
*
|
||||||
// WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
* The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
||||||
// WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
||||||
// PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
* WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
||||||
// ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
* PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
||||||
//
|
* ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
||||||
// IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
*
|
||||||
// CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
||||||
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
// INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
// AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
* INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
||||||
// UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
* AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
||||||
// OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
* UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
||||||
//
|
* OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
// Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
*
|
||||||
//
|
* Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
||||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
#ifndef __CL_FFT_BASE_KERNELS_
|
#ifndef __CL_FFT_BASE_KERNELS_
|
||||||
|
|||||||
@@ -1,49 +1,50 @@
|
|||||||
|
/*!
|
||||||
//
|
* \file fft_internal.h
|
||||||
// File: fft_internal.h
|
* \brief Internals of FFT for OpenCL
|
||||||
//
|
*
|
||||||
// Version: <1.0>
|
*
|
||||||
//
|
* Version: <1.0>
|
||||||
// Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
*
|
||||||
// in consideration of your agreement to the following terms, and your use,
|
* Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple")
|
||||||
// installation, modification or redistribution of this Apple software
|
* in consideration of your agreement to the following terms, and your use,
|
||||||
// constitutes acceptance of these terms. If you do not agree with these
|
* installation, modification or redistribution of this Apple software
|
||||||
// terms, please do not use, install, modify or redistribute this Apple
|
* constitutes acceptance of these terms. If you do not agree with these
|
||||||
// software.
|
* terms, please do not use, install, modify or redistribute this Apple
|
||||||
//
|
* software.¬
|
||||||
// In consideration of your agreement to abide by the following terms, and
|
*
|
||||||
// subject to these terms, Apple grants you a personal, non - exclusive
|
* In consideration of your agreement to abide by the following terms, and
|
||||||
// license, under Apple's copyrights in this original Apple software ( the
|
* subject to these terms, Apple grants you a personal, non - exclusive
|
||||||
// "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
* license, under Apple's copyrights in this original Apple software ( the
|
||||||
// Software, with or without modifications, in source and / or binary forms;
|
* "Apple Software" ), to use, reproduce, modify and redistribute the Apple
|
||||||
// provided that if you redistribute the Apple Software in its entirety and
|
* Software, with or without modifications, in source and / or binary forms;
|
||||||
// without modifications, you must retain this notice and the following text
|
* provided that if you redistribute the Apple Software in its entirety and
|
||||||
// and disclaimers in all such redistributions of the Apple Software. Neither
|
* without modifications, you must retain this notice and the following text
|
||||||
// the name, trademarks, service marks or logos of Apple Inc. may be used to
|
* and disclaimers in all such redistributions of the Apple Software. Neither
|
||||||
// endorse or promote products derived from the Apple Software without specific
|
* the name, trademarks, service marks or logos of Apple Inc. may be used to
|
||||||
// prior written permission from Apple. Except as expressly stated in this
|
* endorse or promote products derived from the Apple Software without specific
|
||||||
// notice, no other rights or licenses, express or implied, are granted by
|
* prior written permission from Apple. Except as expressly stated in this
|
||||||
// Apple herein, including but not limited to any patent rights that may be
|
* notice, no other rights or licenses, express or implied, are granted by
|
||||||
// infringed by your derivative works or by other works in which the Apple
|
* Apple herein, including but not limited to any patent rights that may be
|
||||||
// Software may be incorporated.
|
* infringed by your derivative works or by other works in which the Apple
|
||||||
//
|
* Software may be incorporated.
|
||||||
// The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
*
|
||||||
// WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
* The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
|
||||||
// WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
|
||||||
// PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
* WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
|
||||||
// ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
* PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
|
||||||
//
|
* ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
|
||||||
// IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
*
|
||||||
// CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
|
||||||
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
// INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
// AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
* INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
|
||||||
// UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
* AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
|
||||||
// OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
* UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
|
||||||
//
|
* OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
// Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
*
|
||||||
//
|
* Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
|
||||||
////////////////////////////////////////////////////////////////////////////////////////////////////
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
#ifndef __CLFFT_INTERNAL_H
|
#ifndef __CLFFT_INTERNAL_H
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \file bits.h
|
* \file bits.h
|
||||||
|
* \brief Utilities for bit manipulation of the libswiftnav library
|
||||||
* \author Fergus Noble <fergus@swift-nav.com>
|
* \author Fergus Noble <fergus@swift-nav.com>
|
||||||
*
|
*
|
||||||
* -------------------------------------------------------------------------
|
* -------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \file cnav_msg.h
|
* \file cnav_msg.h
|
||||||
|
* \brief Utilities for CNAV message manipulation of the libswiftnav library
|
||||||
* \author Valeri Atamaniouk <valeri@swift-nav.com>
|
* \author Valeri Atamaniouk <valeri@swift-nav.com>
|
||||||
*
|
*
|
||||||
* -------------------------------------------------------------------------
|
* -------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \file edc.h
|
* \file edc.h
|
||||||
|
* \brief Utilities for CRC computation of the libswiftnav library
|
||||||
* \author Fergus Noble <fergus@swift-nav.com>
|
* \author Fergus Noble <fergus@swift-nav.com>
|
||||||
*
|
*
|
||||||
* -------------------------------------------------------------------------
|
* -------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \file fec.h
|
* \file fec.h
|
||||||
|
* \brief Utilities for the convolutional encoder of the libswiftnav library
|
||||||
* \author Phil Karn, KA9Q
|
* \author Phil Karn, KA9Q
|
||||||
*
|
*
|
||||||
* -------------------------------------------------------------------------
|
* -------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \file swift_common.h
|
* \file swift_common.h
|
||||||
|
* \brief Common definitions used throughout the libswiftnav library
|
||||||
* \author Henry Hallam <henry@swift-nav.com>
|
* \author Henry Hallam <henry@swift-nav.com>
|
||||||
* Fergus Noble <fergus@swift-nav.com>
|
* Fergus Noble <fergus@swift-nav.com>
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user