Added comments to the simplest decode/encode examples.

git-svn-id: https://svn.kapsi.fi/jpa/nanopb@979 e3a754e5-d11d-0410-8d38-ebb782a927b9

1 files changed, 10 insertions, 4 deletions

diff --git a/tests/test_encode1.c b/tests/test_encode1.c
index df1ec4fc..f46e60a6 100644
--- a/tests/test_encode1.c
+++ b/tests/test_encode1.c
@@ -1,11 +1,13 @@
 /* A very simple encoding test case using person.proto.
- * Just puts constant data in the fields.
+ * Just puts constant data in the fields and writes the
+ * data to stdout.
  */
 
 #include <stdio.h>
 #include <pb_encode.h>
 #include "person.pb.h"
 
+/* This binds the pb_ostream_t into the stdout stream */
 bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
 {
     FILE *file = (FILE*) stream->state;
@@ -14,12 +16,16 @@ bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
 
 int main()
 {
+    /* Initialize the structure with constants */
     Person person = {"Test Person 99", 99, true, "test@person.com",
         1, {{"555-12345678", true, Person_PhoneType_MOBILE}}};
     
+    /* Prepare the stream, output goes directly to stdout */
     pb_ostream_t stream = {&streamcallback, stdout, SIZE_MAX, 0};
     
-    pb_encode(&stream, Person_fields, &person);
-    
-    return 0;
+    /* Now encode it and check if we succeeded. */
+    if (pb_encode(&stream, Person_fields, &person))
+        return 0; /* Success */
+    else
+        return 1; /* Failure */
 }