Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

Diff: MaximInterfaceCore/None.hpp

Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
--- a/MaximInterfaceCore/None.hpp	Mon Jul 22 11:44:07 2019 -0500
+++ b/MaximInterfaceCore/None.hpp	Mon Sep 16 11:13:37 2019 -0500
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2019 Maxim Integrated Products, Inc., All Rights Reserved.
+* Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
@@ -30,17 +30,22 @@
 * ownership rights.
 *******************************************************************************/
 
-#ifndef MaximInterfaceCore_None
-#define MaximInterfaceCore_None
+#ifndef MaximInterfaceCore_None_hpp
+#define MaximInterfaceCore_None_hpp
 
 namespace MaximInterfaceCore {
 
+/// @brief Empty tag for use with Function, Optional, Result, and similar types.
+/// @details A predefined instance called "none" is provided.
+/// @see none
 struct None {
-  // Disable default constructor.
+  /// @private
+  /// @brief Disables default constructor.
   explicit None(int) {}
 };
 
-/// Empty tag for use with Optional and similar types.
+/// @copybrief None
+/// @details This is the predefined instance of the None type.
 static const None none(0);
 
 } // namespace MaximInterfaceCore