examples: Add notice about using experimental API

Bug: https://jira.iotivity.org/browse/IOT-1745
Change-Id: I14190ffe2f857d48e062f3f78e9b7b52123efe1b
Signed-off-by: Philippe Coval <philippe.coval@osg.samsung.com>

plugins/samples/linux/IotivityandZigbeeClient.c

@@ -34,11 +34,14 @@
 #include <unistd.h>
 #include <errno.h>
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "oic_string.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+
 #define DEFAULT_CONTEXT_VALUE       (0x99)
 #define MAX_QUERY_SIZE              (1024)
 #define MAX_URI_SIZE                (256)

plugins/samples/linux/IotivityandZigbeeServer.c

@@ -21,13 +21,18 @@
 #include "IotivityandZigbeeServer.h"
 #include <signal.h>
 #include <ocstack.h>
-#include "experimental/logger.h"
+
 #include "oic_string.h"
 #include "oic_malloc.h"
 
 #define TAG "IoTivityZigbeeServer"
 #define defaultComPort "/dev/ttyUSB0"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
+
 #define VERIFY_SUCCESS(op)                          \
 {                                                   \
     if (op !=  OC_STACK_OK)                         \

resource/IPCA/samples/ElevatorServer/elevatorserver.cpp

@@ -17,9 +17,12 @@
  *
  ******************************************************************/
 
-#include "experimental/logger.h"
 #include "elevatorserver.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 using namespace OC;
 using namespace std::placeholders;
 

resource/csdk/resource-directory/samples/rd_publishingClient.cpp

@@ -24,8 +24,11 @@
 #include <limits>
 
 #include "oic_string.h"
-
 #include "rd_client.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+/// logging part is not critical but convenient for developer
 #include "experimental/payload_logging.h"
 
 #define TAG ("RD_PublishClient")

resource/csdk/resource-directory/samples/rd_queryClient.cpp

@@ -21,6 +21,10 @@
 #include <iostream>
 #include "octypes.h"
 #include "ocstack.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+/// logging part is not critical
 #include "experimental/payload_logging.h"
 
 bool g_foundResource = true;

resource/csdk/security/provisioning/sample/autoprovisioningclient.c

@@ -35,9 +35,7 @@
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#include "experimental/payload_logging.h"
 #include "utlist.h"
-#include "experimental/logger.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "ocprovisioningmanager.h"
@@ -50,7 +48,6 @@
 #include "ocsecurity.h"
 #include "ocstackinternal.h"
 #include "pmutility.h"
-#include "experimental/ocrandom.h"
 
 #ifdef _MSC_VER
 #include <io.h>
@@ -59,6 +56,12 @@
 #define access _access_s
 #endif
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+#include "experimental/ocrandom.h"
+
 #ifdef __cplusplus
 extern "C"
 {

resource/csdk/security/provisioning/sample/certgenerator.cpp

@@ -26,7 +26,6 @@
 
 #include "ocstack.h"
 #include "oic_malloc.h"
-#include "experimental/ocrandom.h"
 #include "occertutility.h"
 
 #ifdef HAVE_WINDOWS_H
@@ -37,6 +36,10 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/ocrandom.h"
+
 static long GetFileSize(FILE *f)
 {
     long offset, size;

resource/csdk/security/provisioning/sample/cloud/cloudAuth.c

@@ -19,24 +19,25 @@
  * *****************************************************************/
 
 #include "octypes.h"
-#include "experimental/logger.h"
-#include "experimental/payload_logging.h"
 #include "ocstack.h"
 #include "ocpayload.h"
 #include "psinterface.h"
-#include "experimental/securevirtualresourcetypes.h"
 #include "doxmresource.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "pmutility.h"
 #include "credresource.h"
-#include "experimental/payload_logging.h"
 #include "cacommonutil.h"
-
 #include "utils.h"
 #include "cloudAuth.h"
 #include "cloudCommon.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+#include "experimental/securevirtualresourcetypes.h"
+
 #define TAG "cloudAuth"
 
 #define LOGIN_OK 4

resource/csdk/security/provisioning/sample/cloud/cloudCommon.c

@@ -22,11 +22,9 @@
 #include <string.h>
 
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "octhread.h"
 #include "cathreadpool.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "aclresource.h"
 #include "acl_logging.h"
 #include "crl_logging.h"
@@ -45,6 +43,11 @@
 #include <unistd.h> //for unlink
 #endif
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+
 #define TAG "cloudCommon"
 
 //[IOT-2147] Requests 50-83 are not confirmed to new OCF spec

resource/csdk/security/provisioning/sample/cloud/cloudDiscovery.c

@@ -18,9 +18,7 @@
 //
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "oic_string.h"
 #include "srmresourcestrings.h"
 #include "pmutility.h"
@@ -28,6 +26,11 @@
 #include "cloudCommon.h"
 #include "cloudWrapper.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+
 #define TAG "cloudDiscovery"
 
 #define DISCOVERY_URI "/oic/res"

resource/csdk/security/provisioning/sample/cloud/cloudResource.c

@@ -20,11 +20,13 @@
 #include <string.h>
 #include "cloudCommon.h"
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
-
 #include "cloudResource.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #define TAG "cloudResource"
 
 LEDResource LED;

resource/csdk/security/provisioning/sample/cloud/cloudWrapper.c

@@ -17,16 +17,18 @@
  * limitations under the License.
  *
  * *****************************************************************/
-#include "experimental/logger.h"
 #include "occloudprovisioning.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "srmutility.h"
 #include "aclresource.h"
 #include "utlist.h"
-
 #include "utils.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #define TAG "CLOUD-WRAPPER"
 
 #define MAX_ID_LENGTH       (64)

resource/csdk/security/provisioning/sample/cloudClient.c

@@ -18,6 +18,9 @@
  *
  * *****************************************************************/
 #include "cloudCommon.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 #define TAG "cloudClient"

resource/csdk/security/provisioning/sample/cloudServer.c

@@ -18,9 +18,12 @@
  *
  * *****************************************************************/
 #include "cloudCommon.h"
-#include "experimental/logger.h"
 #include "cloudResource.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #define TAG "cloudServer"
 
 extern LEDResource LED;

resource/csdk/security/provisioning/sample/provisioningclient.c

@@ -25,9 +25,8 @@
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
-#include "experimental/payload_logging.h"
+
 #include "utlist.h"
-#include "experimental/logger.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "ocprovisioningmanager.h"
@@ -43,11 +42,15 @@
 
 #ifdef _MSC_VER
 #include <io.h>
-
 #define F_OK 0
 #define access _access_s
 #endif
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/payload_logging.h"
+#include "experimental/logger.h"
+
 #ifdef __cplusplus
 extern "C"
 {

resource/csdk/security/provisioning/sample/sampleserver_justworks.cpp

@@ -43,9 +43,13 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 #include "platform_features.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 
+
 #define TAG "SAMPLE_JUSTWORKS"
 
 const char * specVersion = "ocf.1.1.0";

resource/csdk/security/provisioning/sample/sampleserver_mfg.cpp

@@ -43,6 +43,9 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 #include "platform_features.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 

resource/csdk/security/provisioning/sample/sampleserver_mvjustworks.cpp

@@ -44,6 +44,9 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 #include "platform_features.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 

resource/csdk/security/provisioning/sample/sampleserver_preconfpin.cpp

@@ -43,6 +43,9 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 #include "platform_features.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 

resource/csdk/security/provisioning/sample/sampleserver_randompin.cpp

@@ -43,6 +43,9 @@
 #endif //ERROR
 #endif //HAVE_WINDOWS_H
 #include "platform_features.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 #define TAG "SAMPLE_RANDOMPIN"

resource/csdk/security/provisioning/sample/subownerclient.c

@@ -28,7 +28,6 @@
 
 #include "platform_features.h"
 #include "utlist.h"
-#include "experimental/logger.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "ocprovisioningmanager.h"
@@ -45,6 +44,10 @@
 #define access _access_s
 #endif
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #ifdef __cplusplus
 extern "C"
 {

resource/csdk/security/provisioning/unittest/sampleserver.cpp

@@ -27,17 +27,20 @@
 #include <time.h>
 
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
 #include "oic_string.h"
 #include "srmutility.h"
 #include "doxmresource.h"
-#include "experimental/ocrandom.h"
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/ocrandom.h"
+
 #define TAG "JW_UNITTEST"
 
 int gQuitFlag = 0;

resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/ocserver.cpp

@@ -21,7 +21,6 @@
 // Do not remove the include below
 #include "Arduino.h"
 
-#include "experimental/logger.h"
 #include "ocstack.h"
 #include "ocpayload.h"
 #include <string.h>
@@ -41,6 +40,9 @@
 #include <EthernetUdp.h>
 #include <Dhcp.h>
 #endif
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
 
 const char *getResult(OCStackResult result);
 

resource/csdk/stack/samples/linux/OCSample/occlient.c

@@ -31,6 +31,9 @@
 #ifdef HAVE_WINDOWS_H
 #include <windows.h>
 #endif
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 #define TAG ("occlient")

resource/csdk/stack/samples/linux/OCSample/ocserver.c

@@ -33,6 +33,9 @@
 #endif
 #include <signal.h>
 #include <stdbool.h>
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 #define TAG ("ocserver")

resource/csdk/stack/samples/linux/SimpleClientServer/occlient.cpp

@@ -44,6 +44,9 @@
 #include <coap/pdu.h>
 #include "occlient.h"
 #include "common.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 #include "experimental/payload_logging.h"
 

resource/csdk/stack/samples/linux/SimpleClientServer/occlientbasicops.cpp

@@ -34,14 +34,17 @@
 #include <getopt.h>
 
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "occlientbasicops.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
 #include "common.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+
 #define MAX_IP_ADDR_ST_SZ  16 //string size of "155.255.255.255" (15 + 1)
 #define MAX_PORT_ST_SZ  6     //string size of "65535" (5 + 1)
 

resource/csdk/stack/samples/linux/SimpleClientServer/occlientcoll.cpp

@@ -34,11 +34,14 @@
 #include <sstream>
 #include <getopt.h>
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
-#include "experimental/logger.h"
 #include "common.h"
 #include "oic_string.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/payload_logging.h"
+#include "experimental/logger.h"
+
 std::string getQueryStrForGetPut();
 
 #define TAG ("occlient")

resource/csdk/stack/samples/linux/SimpleClientServer/occlientslow.cpp

@@ -32,14 +32,18 @@
 #include <iostream>
 #include <sstream>
 #include <getopt.h>
+
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "occlientslow.h"
 #include "oic_string.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "common.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+#include "experimental/payload_logging.h"
+
 // Tracking user input
 static int UnicastDiscovery = 0;
 static int TestCase = 0;

resource/csdk/stack/samples/linux/SimpleClientServer/ocremoteaccessclient.cpp

@@ -26,13 +26,18 @@
 #include <unistd.h>
 #include <iostream>
 #include <sstream>
+
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
-#include "experimental/payload_logging.h"
 #include "ocremoteaccessclient.h"
 #include "common.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/payload_logging.h"
+#include "experimental/logger.h"
+
+
 #define SET_BUT_NOT_USED(x) (void) x
 // Tracking user input
 static int TEST_CASE = 0;

resource/csdk/stack/samples/linux/SimpleClientServer/ocrouting.cpp

@@ -27,10 +27,14 @@
 #include <signal.h>
 #include <pthread.h>
 #include <array>
+
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocpayload.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #define TAG "ocrouting"
 
 int gQuitFlag = 0;

resource/csdk/stack/samples/linux/SimpleClientServer/ocserver.cpp

@@ -43,6 +43,9 @@
 #include "ocserver.h"
 #include "common.h"
 #include "oic_string.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
 #include "experimental/logger.h"
 
 #define VERIFY_SUCCESS(op)                          \

resource/csdk/stack/samples/linux/SimpleClientServer/ocserverbasicops.cpp

@@ -32,11 +32,15 @@
 #ifdef HAVE_PTHREAD_H
 #include <pthread.h>
 #endif
+
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include "ocserverbasicops.h"
 #include "ocpayload.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 //string length of "/a/led/" + std::numeric_limits<int>::digits10 + '\0'"
 // 7 + 9 + 1 = 17
 const int URI_MAXSIZE = 17;

resource/csdk/stack/samples/linux/SimpleClientServer/ocservercoll.cpp

@@ -34,12 +34,16 @@
 #ifdef HAVE_PTHREAD_H
 #include <pthread.h>
 #endif
+
 #include <ocstack.h>
-#include "experimental/logger.h"
 #include <getopt.h>
 #include "ocpayload.h"
 #include "common.h"
 
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
+
 #define TAG PCF("ocservercontainer")
 
 volatile sig_atomic_t gQuitFlag = 0;

resource/csdk/stack/samples/linux/SimpleClientServer/ocserverslow.cpp

@@ -40,9 +40,12 @@
 #include "ocstack.h"
 #include "oic_malloc.h"
 #include "oic_string.h"
-#include "experimental/logger.h"
 #include "ocserverslow.h"
 #include "ocpayload.h"
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"
 #include "experimental/payload_logging.h"
 
 volatile sig_atomic_t gQuitFlag = 0;

resource/csdk/stack/samples/linux/secure/common.cpp

@@ -20,12 +20,16 @@
 #include "common.h"
 
 #include "ocstack.h"
-#include "experimental/logger.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 
+
+/// This example is using experimental API, so there is no guarantee of support for future release,
+/// nor any there any guarantee that breaking changes will not occur across releases.
+#include "experimental/logger.h"