summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorSam Estep <sam@samestep.com>2025-08-18 09:56:42 -0400
committerGitHub <noreply@github.com>2025-08-18 13:56:42 +0000
commit1a4ccba64a140bd404cbd22a9ae0a8e9e5f425d8 (patch)
tree6e861edd0c82db887a8e3b06b7c21fe007daf84e /tools
parentc3df36043c67a94ea51cd7b1ce10a84e52f8d744 (diff)
Show usage of `FIDDLE END` in Fiddle doc example (#7888)
Similar to #7887, this PR improves the Fiddle docs a bit by showing how the `FIDDLE TEMPLATE` example would actually need to include `FIDDLE END` at some point after `FIDDLE OUTPUT`.
Diffstat (limited to 'tools')
-rw-r--r--tools/slang-fiddle/README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/tools/slang-fiddle/README.md b/tools/slang-fiddle/README.md
index 105a9a8e1..2ae57c8e3 100644
--- a/tools/slang-fiddle/README.md
+++ b/tools/slang-fiddle/README.md
@@ -131,7 +131,8 @@ An idiomatic approach would be something like:
class $T;
%end
#else // FIDDLE OUTPUT:
-#endif
+// Fiddle output goes here.
+#endif // FIDDLE END
```
For the template part of things, you can write lines of more-or-less ordinary C++ code, interspersed with two kinds of script code:
@@ -151,7 +152,7 @@ For example, given the input above, the generated output for the template might
#else // FIDDLE OUTPUT:
#define FIDDLE_TEMPLATE_OUTPUT_ID 0
#include "my-class-forward-decls.h.fiddle"
-#endif
+#endif // FIDDLE END
```
Inside templates there is a global defined `THIS_FILE` which is the file path