Showing the changes to src/scripts (1 of 27 files). Show all
Unified · Split
| @@ -1,4 +1,15 @@ | |||
| 1 | // instantiate | 1 | //--------------------------------------------------------------------- |
| 2 | // name: gen-all.ck | ||
| 3 | // desc: generate HTML documentation for chuck website reference | ||
| 4 | // see: https://chuck.stanford.edu/doc/reference/ | ||
| 5 | // | ||
| 6 | // version: need chuck version 1.5.0.0 or higher | ||
| 7 | // | ||
| 8 | // author: Ge Wang (https://ccrma.stanford.edu/~ge/) | ||
| 9 | // date: Spring 2023 | ||
| 10 | //--------------------------------------------------------------------- | ||
| 11 | |||
| 12 | // instantiate a CKDoc object | ||
| 2 | CKDoc doc; // documentation orchestra | 13 | CKDoc doc; // documentation orchestra |
| 3 | // set the examples root | 14 | // set the examples root |
| 4 | "../examples/" => doc.examplesRoot; | 15 | "../examples/" => doc.examplesRoot; |
| @@ -6,9 +17,9 @@ CKDoc doc; // documentation orchestra · 1 unmodified line | |||
| 6 | // add group | 17 | // add group |
| 7 | doc.addGroup( | 18 | doc.addGroup( |
| 8 | // class names | 19 | // class names |
| 9 | ["Object", "Event", "Shred", "Math", "Machine", "Std", "string", "@array"], | 20 | ["Object", "Event", "Shred", "Math", "Machine", "Std", "string", "@array", "CKDoc" ], |
| 10 | // group name | 21 | // group name |
| 11 | "Base Libraries", | 22 | "Base Classes", |
| 12 | // file name | 23 | // file name |
| 13 | "base", | 24 | "base", |
| 14 | // group description | 25 | // group description |
| @@ -124,8 +135,20 @@ doc.addGroup( · 109 unmodified lines | |||
| 124 | "Communication tools, including file input/output, Open Sound Control, MIDI, MIDI file reading, serial i/o." | 135 | "Communication tools, including file input/output, Open Sound Control, MIDI, MIDI file reading, serial i/o." |
| 125 | ); | 136 | ); |
| 126 | 137 | ||
| 138 | // add group | ||
| 139 | doc.addGroup( | ||
| 140 | // class names | ||
| 141 | [ "CKDoc", "StringTokenizer", "ConsoleInput" ], | ||
| 142 | // group name | ||
| 143 | "Utilities", | ||
| 144 | // file name | ||
| 145 | "utils", | ||
| 146 | // group description | ||
| 147 | "Additional Utiilities" | ||
| 148 | ); | ||
| 149 | |||
| 127 | // generate | 150 | // generate |
| 128 | doc.outputToDir( ".", "ChucK Class Library Reference" ); | 151 | doc.outputToDir( ".", "ChucK Class Library Reference" ); |
| 129 | 152 | ||
| 130 | // print what was generated (or add option to) | 153 | // TODO: print what was generated (or add option to) |
| 131 | // print what types are in the type system but wasn't documented | 154 | // TODO: print what types are in the type system but wasn't documented |