Doxygen support added

This commit is contained in:
Simon Rozman 2016-04-11 13:48:32 +02:00
parent a9bbd269bb
commit c004f8c2ef
3 changed files with 2329 additions and 9 deletions

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
/doc
*.user *.user
temp temp

2312
Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

@ -36,8 +36,8 @@ namespace stdex {
/// \param[in] end Position limit. Default is -1 (no limit). /// \param[in] end Position limit. Default is -1 (no limit).
/// ///
/// \returns /// \returns
/// - true when succeeded /// - \c true when succeeded
/// - false otherwise /// - \c false otherwise
/// ///
template <class T_ID> template <class T_ID>
inline bool read_id(_In_ std::istream& stream, _Out_ T_ID &id, _In_opt_ std::streamoff end = (std::streamoff)-1) inline bool read_id(_In_ std::istream& stream, _Out_ T_ID &id, _In_opt_ std::streamoff end = (std::streamoff)-1)
@ -56,8 +56,8 @@ namespace stdex {
/// \param[in] stream Input stream /// \param[in] stream Input stream
/// ///
/// \returns /// \returns
/// - true when successful /// - \c true when successful
/// - false otherwise /// - \c false otherwise
/// ///
template <class T_SIZE, unsigned int ALIGN> template <class T_SIZE, unsigned int ALIGN>
inline bool ignore(_In_ std::istream& stream) inline bool ignore(_In_ std::istream& stream)
@ -84,8 +84,8 @@ namespace stdex {
/// \param[in] end Position limit. Default is -1 (no limit). /// \param[in] end Position limit. Default is -1 (no limit).
/// ///
/// \returns /// \returns
/// - true when found /// - \c true when found
/// - false otherwise /// - \c false otherwise
/// ///
template <class T_ID, class T_SIZE, unsigned int ALIGN> template <class T_ID, class T_SIZE, unsigned int ALIGN>
inline bool find(_In_ std::istream& stream, _In_ T_ID id, _In_opt_ std::streamoff end = (std::streamoff)-1) inline bool find(_In_ std::istream& stream, _In_ T_ID id, _In_opt_ std::streamoff end = (std::streamoff)-1)
@ -178,7 +178,14 @@ namespace stdex {
/// ///
/// \param[in] d Reference to record data /// \param[in] d Reference to record data
/// ///
inline record(_In_ T &d) : data( d) {} inline record(_In_ T &d) : data(d) {}
///
/// Constructs the class
///
/// \param[in] d Reference to record data
///
inline record(_In_ const T &d) : data((T&)d) {} inline record(_In_ const T &d) : data((T&)d) {}
@ -230,8 +237,8 @@ namespace stdex {
/// \param[in] end Position limit. Default is -1 (no limit). /// \param[in] end Position limit. Default is -1 (no limit).
/// ///
/// \returns /// \returns
/// - true when found /// - \c true when found
/// - false otherwise /// - \c false otherwise
/// ///
static inline bool find(_In_ std::istream& stream, _In_opt_ std::streamoff end = (std::streamoff)-1) static inline bool find(_In_ std::istream& stream, _In_opt_ std::streamoff end = (std::streamoff)-1)
{ {