Add final linux LF newline

pull/906/head
a1346054 3 years ago
parent ef276bce72
commit 285e171b54

@ -1,12 +1,12 @@
/** /**
* @file accessmode.h * @file accessmode.h
* @author L.-C. C. * @author L.-C. C.
* @brief * @brief
* @version 0.1 * @version 0.1
* @date 2019-01-20 * @date 2019-01-20
* *
* @copyright Copyright (c) 2019 * @copyright Copyright (c) 2019
* *
*/ */
#pragma once #pragma once
@ -46,4 +46,4 @@ namespace safe
static constexpr bool IsReadOnly = true; static constexpr bool IsReadOnly = true;
}; };
#endif // __cplusplus >= 201402L #endif // __cplusplus >= 201402L
} // namespace safe } // namespace safe

@ -1,12 +1,12 @@
/** /**
* @file defaulttypes.h * @file defaulttypes.h
* @author L.-C. C. * @author L.-C. C.
* @brief * @brief
* @version 0.1 * @version 0.1
* @date 2020-01-29 * @date 2020-01-29
* *
* @copyright Copyright (c) 2020 * @copyright Copyright (c) 2020
* *
*/ */
#pragma once #pragma once
@ -20,4 +20,4 @@ namespace safe
using DefaultReadOnlyLock = std::lock_guard<MutexType>; using DefaultReadOnlyLock = std::lock_guard<MutexType>;
template<typename MutexType> template<typename MutexType>
using DefaultReadWriteLock = std::lock_guard<MutexType>; using DefaultReadWriteLock = std::lock_guard<MutexType>;
} // namespace safe } // namespace safe

@ -1,12 +1,12 @@
/** /**
* @file mutableref.h * @file mutableref.h
* @author L.-C. C. * @author L.-C. C.
* @brief * @brief
* @version 0.1 * @version 0.1
* @date 2020-01-03 * @date 2020-01-03
* *
* @copyright Copyright (c) 2020 * @copyright Copyright (c) 2020
* *
*/ */
#pragma once #pragma once
@ -21,7 +21,7 @@ namespace safe
* @brief A helper class that defines a member variable of type * @brief A helper class that defines a member variable of type
* Type. The variable is defined "mutable Type" if Type is not a * Type. The variable is defined "mutable Type" if Type is not a
* reference, the variable is "Type&" if Type is a reference. * reference, the variable is "Type&" if Type is a reference.
* *
* @tparam Type The type of the variable to define. * @tparam Type The type of the variable to define.
*/ */
template<typename Type> template<typename Type>
@ -37,4 +37,4 @@ namespace safe
Type& get; Type& get;
}; };
} // namespace impl } // namespace impl
} // namespace safe } // namespace safe

@ -1,12 +1,12 @@
/** /**
* @file safe.h * @file safe.h
* @author L.-C. C. * @author L.-C. C.
* @brief * @brief
* @version 0.1 * @version 0.1
* @date 2018-09-21 * @date 2018-09-21
* *
* @copyright Copyright (c) 2018 * @copyright Copyright (c) 2018
* *
*/ */
#pragma once #pragma once
@ -34,10 +34,10 @@ namespace safe
*/ */
struct DefaultConstructMutex {}; struct DefaultConstructMutex {};
static constexpr DefaultConstructMutex default_construct_mutex; static constexpr DefaultConstructMutex default_construct_mutex;
/** /**
* @brief Wraps a value together with a mutex. * @brief Wraps a value together with a mutex.
* *
* @tparam ValueType The type of the value to protect. * @tparam ValueType The type of the value to protect.
* @tparam MutexType The type of the mutex. * @tparam MutexType The type of the mutex.
*/ */
@ -53,7 +53,7 @@ namespace safe
/** /**
* @brief Manages a mutex and gives pointer-like access to a value * @brief Manages a mutex and gives pointer-like access to a value
* object. * object.
* *
* @tparam LockType The type of the lock object that manages the * @tparam LockType The type of the lock object that manages the
* mutex, example: std::lock_guard. * mutex, example: std::lock_guard.
* @tparam Mode Determines the access mode of the Access * @tparam Mode Determines the access mode of the Access
@ -83,7 +83,7 @@ namespace safe
* @brief Construct an Access object from a possibly const * @brief Construct an Access object from a possibly const
* reference to the value object and any additionnal argument * reference to the value object and any additionnal argument
* needed to construct the Lock object. * needed to construct the Lock object.
* *
* @tparam LockArgs Deduced from lockArgs. * @tparam LockArgs Deduced from lockArgs.
* @param value Reference to the value. * @param value Reference to the value.
* @param lockArgs Arguments needed to construct the lock object. * @param lockArgs Arguments needed to construct the lock object.
@ -99,12 +99,12 @@ namespace safe
* @brief Construct a read-only Access object from a const * @brief Construct a read-only Access object from a const
* safe::Safe object and any additionnal argument needed to * safe::Safe object and any additionnal argument needed to
* construct the Lock object. * construct the Lock object.
* *
* If needed, you can provide additionnal arguments to construct * If needed, you can provide additionnal arguments to construct
* the lock object (such as std::adopt_lock). The mutex from the * the lock object (such as std::adopt_lock). The mutex from the
* safe::Locakble object is already passed to the lock object's * safe::Locakble object is already passed to the lock object's
* constructor though, you must not provide it. * constructor though, you must not provide it.
* *
* @tparam OtherLockArgs Deduced from otherLockArgs. * @tparam OtherLockArgs Deduced from otherLockArgs.
* @param safe The const Safe object to give protected access to. * @param safe The const Safe object to give protected access to.
* @param otherLockArgs Other arguments needed to construct the lock * @param otherLockArgs Other arguments needed to construct the lock
@ -120,12 +120,12 @@ namespace safe
* @brief Construct a read-write Access object from a * @brief Construct a read-write Access object from a
* safe::Safe object and any additionnal argument needed to * safe::Safe object and any additionnal argument needed to
* construct the Lock object. * construct the Lock object.
* *
* If needed, you can provide additionnal arguments to construct * If needed, you can provide additionnal arguments to construct
* the lock object (such as std::adopt_lock). The mutex from the * the lock object (such as std::adopt_lock). The mutex from the
* safe object is already passed to the lock object's constructor * safe object is already passed to the lock object's constructor
* though, you must not provide it. * though, you must not provide it.
* *
* @tparam OtherLockArgs Deduced from otherLockArgs. * @tparam OtherLockArgs Deduced from otherLockArgs.
* @param safe The Safe object to give protected access to. * @param safe The Safe object to give protected access to.
* @param otherLockArgs Other arguments needed to construct the lock * @param otherLockArgs Other arguments needed to construct the lock
@ -141,7 +141,7 @@ namespace safe
* @brief Construct an Access object from another one. * @brief Construct an Access object from another one.
* OtherLockType must implement release() like std::unique_lock * OtherLockType must implement release() like std::unique_lock
* does. * does.
* *
* @tparam OtherLockType Deduced from otherAccess. * @tparam OtherLockType Deduced from otherAccess.
* @tparam OtherMode Deduced from otherAccess. * @tparam OtherMode Deduced from otherAccess.
* @tparam OtherLockArgs Deduced from otherLockArgs. * @tparam OtherLockArgs Deduced from otherLockArgs.
@ -215,7 +215,7 @@ namespace safe
using ReadAccess = Access<LockType, AccessMode::ReadOnly>; using ReadAccess = Access<LockType, AccessMode::ReadOnly>;
template<template<typename> class LockType=DefaultReadWriteLock> template<template<typename> class LockType=DefaultReadWriteLock>
using WriteAccess = Access<LockType, AccessMode::ReadWrite>; using WriteAccess = Access<LockType, AccessMode::ReadWrite>;
/** /**
* @brief Construct a Safe object * @brief Construct a Safe object
*/ */
@ -225,7 +225,7 @@ namespace safe
* @brief Construct a Safe object with default construction of * @brief Construct a Safe object with default construction of
* the mutex and perfect forwarding of the other arguments to * the mutex and perfect forwarding of the other arguments to
* construct the value object. * construct the value object.
* *
* @tparam ValueArgs Deduced from valueArgs. * @tparam ValueArgs Deduced from valueArgs.
* @param valueArgs Perfect forwarding arguments to construct the value object. * @param valueArgs Perfect forwarding arguments to construct the value object.
* @param tag Indicates that the mutex should be default constructed. * @param tag Indicates that the mutex should be default constructed.
@ -239,7 +239,7 @@ namespace safe
* @brief Construct a Safe object, forwarding the first * @brief Construct a Safe object, forwarding the first
* argument to construct the mutex and the other arguments to * argument to construct the mutex and the other arguments to
* construct the value object. * construct the value object.
* *
* @tparam MutexArg Deduced from mutexArg. * @tparam MutexArg Deduced from mutexArg.
* @tparam ValueArgs Deduced from valueArgs. * @tparam ValueArgs Deduced from valueArgs.
* @param valueArgs Perfect forwarding arguments to construct the * @param valueArgs Perfect forwarding arguments to construct the
@ -296,7 +296,7 @@ namespace safe
/** /**
* @brief Unsafe const accessor to the value. If you use this * @brief Unsafe const accessor to the value. If you use this
* function, you exit the realm of safe! * function, you exit the realm of safe!
* *
* @return ConstValueReferenceType Const reference to the value * @return ConstValueReferenceType Const reference to the value
* object. * object.
*/ */
@ -307,7 +307,7 @@ namespace safe
/** /**
* @brief Unsafe accessor to the value. If you use this function, * @brief Unsafe accessor to the value. If you use this function,
* you exit the realm of safe! * you exit the realm of safe!
* *
* @return ValueReferenceType Reference to the value object. * @return ValueReferenceType Reference to the value object.
*/ */
ValueReferenceType unsafe() noexcept ValueReferenceType unsafe() noexcept
@ -317,7 +317,7 @@ namespace safe
/** /**
* @brief Accessor to the mutex. * @brief Accessor to the mutex.
* *
* @return MutexReferenceType Reference to the mutex. * @return MutexReferenceType Reference to the mutex.
*/ */
MutexReferenceType mutex() const noexcept MutexReferenceType mutex() const noexcept
@ -334,7 +334,7 @@ namespace safe
/** /**
* @brief Type alias for read-only Access. * @brief Type alias for read-only Access.
* *
* @tparam SafeType The type of Safe object to give read-only access to. * @tparam SafeType The type of Safe object to give read-only access to.
* @tparam LockType=DefaultReadOnlyLock The type of lock. * @tparam LockType=DefaultReadOnlyLock The type of lock.
*/ */
@ -345,7 +345,7 @@ namespace safe
/** /**
* @brief Type alias for read-write Access. * @brief Type alias for read-write Access.
* *
* @tparam SafeType The type of Safe object to give read-write access to. * @tparam SafeType The type of Safe object to give read-write access to.
* @tparam LockType=DefaultReadWriteLock The type of lock. * @tparam LockType=DefaultReadWriteLock The type of lock.
*/ */
@ -356,4 +356,4 @@ namespace safe
} // namespace safe } // namespace safe
#undef EXPLICIT_IF_CPP17 #undef EXPLICIT_IF_CPP17
#undef EXPLICITLY_CONSTRUCT_RETURN_TYPE_IF_CPP17 #undef EXPLICITLY_CONSTRUCT_RETURN_TYPE_IF_CPP17

Loading…
Cancel
Save