examples: add more documentation

Author: Grok Compression

.vscode/launch.json

@@ -171,10 +171,10 @@
             "miDebuggerPath": "/usr/bin/gdb"
         },
         {
-            "name": "core compress decompress",
+            "name": "core simple",
             "type": "cppdbg",
             "request": "launch",
-            "program": "${workspaceFolder}/build/bin/core_compress_decompress",
+            "program": "${workspaceFolder}/build/bin/core_simple",
             "args": [],
             "environment": [
                 { "name": "GRK_DEBUG", "value": "3" }

examples/core/CMakeLists.txt

@@ -8,7 +8,7 @@ include_directories(
 
 foreach(exe core_decompress
             core_compress
-            core_compress_decompress
+            core_simple
 )
   add_executable(${exe} ${exe}.cpp ${common_SRCS})
   target_compile_options(${exe} PRIVATE ${GROK_COMPILE_OPTIONS})

examples/core/core_compress.cpp

@@ -14,6 +14,18 @@
  *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  */
+
+/*********************************************************************
+
+Example demonstrating compression from a memory buffer using one
+of three approaches for the destination:
+
+1) memory buffer
+2) memory buffer using callbacks
+3) file
+
+**********************************************************************/
+
 #include <cstdio>
 #include <cstring>
 #include <memory>

examples/core/core_decompress.cpp

@@ -15,6 +15,12 @@
  *
  */
 
+/*************************************************************************
+
+Complex example demonstrating a variety of options for decompression
+
+**************************************************************************/
+
 #include <cstdio>
 #include <string>
 #include <cstring>

…amples/core/core_compress_decompress.cpp examples/core/core_simple.cppexamples/core/core_compress_decompress.cpp renamed to examples/core/core_simple.cpp examples/core/core_compress_decompress.cpp renamed to examples/core/core_simple.cpp

@@ -14,6 +14,14 @@
  *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  */
+
+/***********************************************************
+
+Simple example demonstrating compression and decompression
+with memory buffers as source and destination
+
+************************************************************/
+
 #include <cstdio>
 #include <cstring>
 #include <memory>