zephyr/lib/libc/minimal/include/bits/restrict.h
Peter Mitsis 8413e1f872 doc: Fix misuse of @file doxygen tag
Summary lines follow the @brief tag instead of the @file tag.

This prevents doxygen build warnings such as ...

    The name xxx supplied as the second argument in the \file
    statement is not an input file

Change-Id: I1014586ad21be12e14aa1d2a942e6b8a11211795
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-11 20:11:03 +00:00

36 lines
1.0 KiB
C

/*
* Copyright (c) 2016 Wind River Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @brief _Restrict definition
*
* The macro "_Restrict" is intended to be private to the minimal libc library.
* It evaluates to the "restrict" keyword when a C99 compiler is used, and
* to "__restrict__" when a C++ compiler is used.
*/
#if !defined(_Restrict_defined)
#define _Restrict_defined
#ifdef __cplusplus
#define _Restrict __restrict__
#else
#define _Restrict restrict
#endif
#endif