1 files changed, 51 insertions, 0 deletions
diff --git a/doc/overview_code.c b/doc/overview_code.c
new file mode 100644
index 0000000..1370292
--- /dev/null
+++ b/doc/overview_code.c
@@ -0,0 +1,51 @@
+// Copyright 2021-2022 David Robillard <d@drobilla.net>
+// SPDX-License-Identifier: ISC
+
+/*
+  Example code that is included in the documentation.  Code in the
+  documentation is included from here rather than written inline so that it can
+  be tested and avoid rotting.  The code here doesn't make much sense, but is
+  written such that it at least compiles and will run without crashing.
+*/
+
+#include "zix/attributes.h"
+#include "zix/string_view.h"
+
+#if defined(__GNUC__)
+#  pragma GCC diagnostic push
+#  pragma GCC diagnostic ignored "-Wunused-variable"
+#endif
+
+static void
+string_views(void)
+{
+  const char* const string_pointer = "some string";
+
+  // begin make-empty-string
+  ZixStringView empty = zix_empty_string();
+  // end make-empty-string
+
+  // begin make-static-string
+  ZixStringView hello = zix_string("hello");
+  // end make-static-string
+
+  // begin measure-string
+  ZixStringView view = zix_string(string_pointer);
+  // end measure-string
+
+  // begin make-string-view
+  ZixStringView slice = zix_substring(string_pointer, 4);
+  // end make-string-view
+}
+
+ZIX_CONST_FUNC
+int
+main(void)
+{
+  string_views();
+  return 0;
+}
+
+#if defined(__GNUC__)
+#  pragma GCC diagnostic pop
+#endif