Showing the changes to src/scripts (2 of 7 files). Show all
Unified · Split
| @@ -15,7 +15,27 @@ Type.getTypes( · 14 unmodified lines | ||
| 15 | 15 | // instantiate |
| 16 | 16 | CKDoc doc; // documentation orchestra |
| 17 | 17 | |
| 18 | +// set the examples root | |
| 19 | +"https://chuck.stanford.edu/doc/examples/" => doc.examplesRoot; | |
| 20 | + | |
| 21 | +// add as group | |
| 22 | +doc.addGroup( types, "Base Types (compiled in)", "base", "Base types in the ChucK" ); | |
| 23 | + | |
| 24 | +types.clear(); | |
| 25 | +// get types currently in ChucK type system | |
| 26 | +Type.getTypes( | |
| 27 | + types, // to be filled with results | |
| 28 | + true, // include objects | |
| 29 | + false, // include primitive types | |
| 30 | + false, // include special types (@array and @function) | |
| 31 | + false, // include builtin types | |
| 32 | + true, // include types from chugins | |
| 33 | + false, // include types from ck files in lib path | |
| 34 | + false // include user-defined classes | |
| 35 | +); | |
| 36 | + | |
| 18 | 37 | // add as group |
| 19 | −doc.addGroup( types, "All", "all", "Here are some types in the ChucK VM" ); | |
| 38 | +doc.addGroup( types, "Base Types (chugins)", "chugins", "ChucK Objects loaded from chugins" ); | |
| 39 | + | |
| 20 | 40 | // generate |
| 21 | −doc.outputToDir( "." ); | |
| 41 | +doc.outputToDir( ".", "ChucK Class Library Reference" ); | |
| @@ -0,0 +1,25 @@ | ||
| 1 | +public class Foo | |
| 2 | +{ | |
| 3 | + /** a is an integer; nothing uses this. */ | |
| 4 | + int a; | |
| 5 | + /** b is a float; nothing uses this either. */ | |
| 6 | + float b; | |
| 7 | + | |
| 8 | + /** this function does nothing. */ | |
| 9 | + fun void bar( int x ) | |
| 10 | + { | |
| 11 | + // \o/ this function does nothing" \o/ | |
| 12 | + // => this function does nothing" <= | |
| 13 | + //=> this function does nothing | |
| 14 | + /*=> */ | |
| 15 | + } | |
| 16 | +} | |
| 17 | + | |
| 18 | +[ Foo.typeOf() ] @=> Type types[]; | |
| 19 | + | |
| 20 | +CKDoc doc; | |
| 21 | + | |
| 22 | +doc.addGroup( types, "my classes!", "my", "Will this work?" ); | |
| 23 | + | |
| 24 | +// generate | |
| 25 | +doc.outputToDir( ".", "My Class Library" ); | |