Use //! for script docs.

rhaiscript · Jul 24, 2022 · 45acb65 · 45acb65
1 parent e8d6e3f
commit 45acb65
Show file tree

Hide file tree

Showing 28 changed files with 30 additions and 29 deletions.
diff --git a/examples/event_handler_js/script.rhai b/examples/event_handler_js/script.rhai
@@ -1,4 +1,4 @@
-// Implementation of the Event Handler With State Pattern - JS Style
+//! Implementation of the Event Handler With State Pattern - JS Style
 
 /// Initialize user-provided state.
 fn init() {

diff --git a/examples/event_handler_main/script.rhai b/examples/event_handler_main/script.rhai
@@ -1,4 +1,4 @@
-// Implementation of the Event Handler With State Pattern - Main Style
+//! Implementation of the Event Handler With State Pattern - Main Style
 
 /// Initialize user-provided state (shadows system-provided state, if any).
 fn init() {

diff --git a/examples/event_handler_map/script.rhai b/examples/event_handler_map/script.rhai
@@ -1,4 +1,4 @@
-// Implementation of the Event Handler With State Pattern - Map Style
+//! Implementation of the Event Handler With State Pattern - Map Style
 
 /// Initialize user-provided state.
 /// State is stored inside an object map bound to 'state'.

diff --git a/scripts/assignment.rhai b/scripts/assignment.rhai
@@ -1,4 +1,4 @@
-// This script contains a single assignment statement.
+//! This script contains a single assignment statement.
 
 let x = 78;
 

diff --git a/scripts/doc-comments.rhai b/scripts/doc-comments.rhai
@@ -1,3 +1,5 @@
+//! This script illustrates how to put doc-comments on functions.
+
 /// The function `foo`, which prints `hello, world!` and a magic number,
 /// accepts three parameters.
 ///

diff --git a/scripts/fibonacci.rhai b/scripts/fibonacci.rhai
@@ -1,5 +1,5 @@
-// This script calculates the n-th Fibonacci number using a really dumb algorithm
-// to test the speed of the scripting engine.
+//! This script calculates the n-th Fibonacci number using a really dumb algorithm
+//! to test the speed of the scripting engine.
 
 const TARGET = 28;
 const REPEAT = 5;

diff --git a/scripts/for1.rhai b/scripts/for1.rhai
@@ -1,4 +1,4 @@
-// This script runs for-loops.
+//! This script runs for-loops.
 
 let arr = [1, true, 123.456, "hello", 3, 42];
 

diff --git a/scripts/for2.rhai b/scripts/for2.rhai
@@ -1,4 +1,4 @@
-// This script runs for-loops
+//! This script runs for-loops
 
 const MAX = 1_000_000;
 

diff --git a/scripts/for3.rhai b/scripts/for3.rhai
@@ -1,4 +1,4 @@
-// This script runs for-loops with closures.
+//! This script runs for-loops with closures.
 
 const MAX = 100;
 const CHECK = ((MAX - 1) ** 2) * MAX;

diff --git a/scripts/function_decl1.rhai b/scripts/function_decl1.rhai
@@ -1,4 +1,4 @@
-// This script defines a function and calls it.
+//! This script defines a function and calls it.
 
 fn call_me() {
     return 3;

diff --git a/scripts/function_decl2.rhai b/scripts/function_decl2.rhai
@@ -1,4 +1,4 @@
-// This script defines a function with two parameters and local variables.
+//! This script defines a function with two parameters and local variables.
 
 let a = 3;
 

diff --git a/scripts/function_decl3.rhai b/scripts/function_decl3.rhai
@@ -1,5 +1,4 @@
-// This script defines a function with many parameters.
-// 
+//! This script defines a function with many parameters.
 
 const KEY = 38;
 

diff --git a/scripts/function_decl4.rhai b/scripts/function_decl4.rhai
@@ -1,4 +1,4 @@
-// This script defines a function that acts as a method.
+//! This script defines a function that acts as a method.
 
 // Use 'this' to refer to the object of a method call
 fn action(x, y) {

diff --git a/scripts/if1.rhai b/scripts/if1.rhai
@@ -1,4 +1,4 @@
-// This script runs if statements.
+//! This script runs if statements.
 
 let a = 42;
 let b = 123;

diff --git a/scripts/if2.rhai b/scripts/if2.rhai
@@ -1,4 +1,4 @@
-// This script runs an if expression.
+//! This script runs an if expression.
 
 let a = 42;
 let b = 123;

diff --git a/scripts/loop.rhai b/scripts/loop.rhai
@@ -1,4 +1,4 @@
-// This script runs an infinite loop, ending it with a break statement.
+//! This script runs an infinite loop, ending it with a break statement.
 
 let x = 10;
 

diff --git a/scripts/mat_mul.rhai b/scripts/mat_mul.rhai
@@ -1,4 +1,4 @@
-// This script simulates multi-dimensional matrix calculations.
+//! This script simulates multi-dimensional matrix calculations.
 
 const SIZE = 50;
 

diff --git a/scripts/module.rhai b/scripts/module.rhai
@@ -1,4 +1,4 @@
-// This script imports an external script as a module.
+//! This script imports an external script as a module.
 
 import "loop" as x;
 

diff --git a/scripts/oop.rhai b/scripts/oop.rhai
@@ -1,4 +1,4 @@
-// This script simulates object-oriented programming (OOP) techniques using closures.
+//! This script simulates object-oriented programming (OOP) techniques using closures.
 
 // External variable that will be captured.
 let last_value = ();

diff --git a/scripts/op1.rhai b/scripts/op1.rhai
@@ -1,4 +1,4 @@
-// This script runs a single expression.
+//! This script runs a single expression.
 
 print("The result should be 46:");
 

diff --git a/scripts/op2.rhai b/scripts/op2.rhai
@@ -1,4 +1,4 @@
-// This script runs a complex expression.
+//! This script runs a complex expression.
 
 print("The result should be 182:");
 

diff --git a/scripts/op3.rhai b/scripts/op3.rhai
@@ -1,4 +1,4 @@
-// This script runs a complex expression.
+//! This script runs a complex expression.
 
 print("The result should be 230:");
 

diff --git a/scripts/primes.rhai b/scripts/primes.rhai
@@ -1,4 +1,4 @@
-// This script uses the Sieve of Eratosthenes to calculate prime numbers.
+//! This script uses the Sieve of Eratosthenes to calculate prime numbers.
 
 let now = timestamp();
 

diff --git a/scripts/speed_test.rhai b/scripts/speed_test.rhai
@@ -1,4 +1,4 @@
-// This script runs 1 million iterations to test the speed of the scripting engine.
+//! This script runs 1 million iterations to test the speed of the scripting engine.
 
 let now = timestamp();
 let x = 1_000_000;

diff --git a/scripts/string.rhai b/scripts/string.rhai
@@ -1,4 +1,4 @@
-// This script tests string operations.
+//! This script tests string operations.
 
 print("hello");
 print("this\nis \\ nice");      // escape sequences

diff --git a/scripts/strings_map.rhai b/scripts/strings_map.rhai
@@ -1,4 +1,4 @@
-// This script tests object maps and strings.
+//! This script tests object maps and strings.
 
 print("Ready... Go!");
 

diff --git a/scripts/switch.rhai b/scripts/switch.rhai
@@ -1,4 +1,4 @@
-// This script runs a switch statement in a for-loop.
+//! This script runs a switch statement in a for-loop.
 
 let arr = [42, 123.456, "hello", true, "hey", 'x', 999, 1, 2, 3, 4];
 

diff --git a/scripts/while.rhai b/scripts/while.rhai
@@ -1,4 +1,4 @@
-// This script runs a while loop.
+//! This script runs a while loop.
 
 let x = 10;