Showing the changes to src/scripts (1 of 5 files). Show all
Unified · Split
| @@ -0,0 +1,131 @@ | |||
| 1 | // instantiate | ||
| 2 | CKDoc doc; // documentation orchestra | ||
| 3 | // set the examples root | ||
| 4 | "../examples/" => doc.examplesRoot; | ||
| 5 | |||
| 6 | // add group | ||
| 7 | doc.addGroup( | ||
| 8 | // class names | ||
| 9 | ["Object", "Event", "Shred", "Math", "Machine", "Std", "string", "@array"], | ||
| 10 | // group name | ||
| 11 | "Base Libraries", | ||
| 12 | // file name | ||
| 13 | "base", | ||
| 14 | // group description | ||
| 15 | "Basic classes (Object, Event, Shred, etc.) and standard libraries (Math, Machine, Std)" | ||
| 16 | ); | ||
| 17 | |||
| 18 | // add group | ||
| 19 | doc.addGroup( | ||
| 20 | // class names | ||
| 21 | [ "UGen", "Gain", "Impulse", "Step", "SndBuf", "ADSR", "Envelope", | ||
| 22 | "Delay", "DelayL", "DelayA", "DelayP", "Echo", "Noise", "CNoise", | ||
| 23 | "Osc", "SinOsc", "TriOsc", "SawOsc", "PulseOsc", "SqrOsc", "Phasor", | ||
| 24 | "HalfRect", "FullRect", "Chugraph", "Chugen", "UGen_Multi", | ||
| 25 | "UGen_Stereo", "SndBuf2", "Mix2", "Pan2" ], | ||
| 26 | // group name | ||
| 27 | "Basic Unit Generators", | ||
| 28 | // file name | ||
| 29 | "ugens-basic", | ||
| 30 | // group description | ||
| 31 | "Basic unit generator (UGen) base classes, simple signal generators, envelopes, and more." | ||
| 32 | ); | ||
| 33 | |||
| 34 | // add group | ||
| 35 | doc.addGroup( | ||
| 36 | [ "FilterBasic", | ||
| 37 | "LPF", "HPF", "BPF", "BRF", "BiQuad", "ResonZ", | ||
| 38 | "OnePole", "OneZero", "TwoPole", "TwoZero", "PoleZero" ], | ||
| 39 | // group name | ||
| 40 | "Basic Filter UGens", | ||
| 41 | // file name | ||
| 42 | "ugens-filters", | ||
| 43 | // group description | ||
| 44 | "Basic filter unit generators." | ||
| 45 | ); | ||
| 46 | |||
| 47 | // add group | ||
| 48 | doc.addGroup( | ||
| 49 | [ "JCRev", "NRev", "PRCRev", "Chorus", "Modulate", "PitShift", | ||
| 50 | "SubNoise", "BLT", "Blit", "BlitSaw", "BlitSquare", "FilterStk", | ||
| 51 | "WvIn", "WaveLoop", "WvOut", "StkInstrument", "BandedWG", | ||
| 52 | "BlowBotl", "BlowHole", "Bowed", "Brass", "Clarinet", "Flute", | ||
| 53 | "Mandolin", "ModalBar", "Moog", "Saxofony", "Shakers", "Sitar", | ||
| 54 | "StifKarp", "VoicForm", "FM", "BeeThree", "FMVoices", "HevyMetl", | ||
| 55 | "PercFlut", "Rhodey", "TubeBell", "Wurley" ], | ||
| 56 | // group name | ||
| 57 | "Synthesis Toolkit (STK) UGens", | ||
| 58 | // file name | ||
| 59 | "ugens-stk", | ||
| 60 | "Utilities and physical models from the Synthesis Toolkit (STK) by Perry R. Cook and Gary Scavone." | ||
| 61 | ); | ||
| 62 | |||
| 63 | // add group | ||
| 64 | doc.addGroup( | ||
| 65 | [ "LiSa", "LiSa2", "liSa4", "LiSa6", "LiSa8", "LiSa10", "LiSa16", | ||
| 66 | "GenX", "Gen5", "Gen7", "Gen9", "Gen10", "Gen17", "CurveTable", | ||
| 67 | "WarpTable", "Dyno" ], | ||
| 68 | // group name | ||
| 69 | "Advanced Unit Generators", | ||
| 70 | // file name | ||
| 71 | "ugens-advanced", | ||
| 72 | // group description | ||
| 73 | "Advanced and specialty unit generators" | ||
| 74 | ); | ||
| 75 | |||
| 76 | // add group | ||
| 77 | doc.addGroup( | ||
| 78 | [ "ABSaturator", "AmbPan3", "Bitcrusher", "Elliptic", "ExpDelay", "ExpEnv", "FIR", | ||
| 79 | "FoldbackSaturator", "GVerb", "KasFilter", "MagicSine", "Mesh2D", "Multicomb", | ||
| 80 | "Pan4", "Pan8", "Pan16", "PitchTrack", "PowerADSR", "Sigmund", "Spectacle", | ||
| 81 | "WinFuncEnv", "WPDiodeLadder", "WPKorg35" ], | ||
| 82 | // group name | ||
| 83 | "Chugins Library", | ||
| 84 | // file name | ||
| 85 | "chugins", | ||
| 86 | // group descriptions | ||
| 87 | "Distribution chugins ranging from unit generators to utilities." | ||
| 88 | ); | ||
| 89 | |||
| 90 | // add group | ||
| 91 | doc.addGroup( | ||
| 92 | [ "Centroid", "Chroma", "Flux", "Kurtosis", "MFCC", "RMS", "RollOff", "SFM", "ZeroX", | ||
| 93 | "AutoCorr", "DCT", "FeatureCollector", "FFT", "Flip", "IDCT", "IFFT", "UnFlip", "XCorr" ], | ||
| 94 | // group name | ||
| 95 | "Unit Analyzers", | ||
| 96 | // file name | ||
| 97 | "uanae", | ||
| 98 | // group description | ||
| 99 | "Unit analyzer (UAna) objects are specialized UGens that can also pass analysis information to other UAnae." | ||
| 100 | ); | ||
| 101 | |||
| 102 | // add group | ||
| 103 | doc.addGroup( | ||
| 104 | [ "MLP", "KNN", "KNN2", "HMM", "SVM", "Word2Vec", "PCA", "Wekinator", "AI" ], | ||
| 105 | // group name | ||
| 106 | "AI tools", | ||
| 107 | // file name | ||
| 108 | "chai", | ||
| 109 | // group description | ||
| 110 | "ChucK for AI (ChAI) class library. These artificial intelligence-related tools are designed to support interactive ML for music." | ||
| 111 | ); | ||
| 112 | |||
| 113 | // add group | ||
| 114 | doc.addGroup( | ||
| 115 | [ "IO", "FileIO", "StdOut", "StdErr", | ||
| 116 | "OscIn", "OscOut", "OscMsg", | ||
| 117 | "Hid", "HidMsg", "SerialIO", | ||
| 118 | "MidiIn", "MidiOut", "MidiMsg", "MidiFileIn" ], | ||
| 119 | // group name | ||
| 120 | "Input / Output", | ||
| 121 | // file name | ||
| 122 | "io", | ||
| 123 | // group descriptions | ||
| 124 | "Communication tools, including file input/output, Open Sound Control, MIDI, MIDI file reading, serial i/o." | ||
| 125 | ); | ||
| 126 | |||
| 127 | // generate | ||
| 128 | doc.outputToDir( ".", "ChucK Class Library Reference" ); | ||
| 129 | |||
| 130 | // print what was generated (or add option to) | ||
| 131 | // print what types are in the type system but wasn't documented | ||