sigrid/chuck

src/core/chuck_io.cpp+5−4

 {
     // init as base class
     Chuck_DL_Func * func = NULL;
-    std::string doc = "";
+    std::string doc = "Base class for other IO classes such as FileIO, StdOut and StdErr. Besides IO.newline(), it’s unlikely you need to use this class directly.";
     // log
     EM_log( CK_LOG_SEVERE, "class 'IO'" );
     // init as base class
     // TODO: ctor/dtor?
     // TODO: replace dummy with pure function
-    if( !type_engine_import_class_begin( env, type, env->global(), fileio_ctor, fileio_dtor ) )
+    if( !type_engine_import_class_begin( env, type, env->global(), fileio_ctor, fileio_dtor,
+        "Helper class doing file-related operations such as reading, writing, seeking, etc. See examples for usage." ) )
         return FALSE;
     // add open(string)
     EM_log( CK_LOG_SEVERE, "class 'chout'" );
     // TODO: ctor/dtor?
-    if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL ) )
+    if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, "Do not instantiate this class directly! Use `chout` instead." ) )
         return FALSE;
     // add good()
     EM_log( CK_LOG_SEVERE, "class 'cherr'" );
     // TODO: ctor/dtor?
-    if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL ) )
+    if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, "Do not instantiate this class directly! Use `cherr` instead." ) )
         return FALSE;
     // add good()

src/core/uana_extract.cpp+13−4

     //---------------------------------------------------------------------
     doc =
-        "A unit analyzer that computes the RMS power mean from a magnitude spectrum (either from an incoming UAna, or given manually), and outputs a single number.";
+        "A unit analyzer that computes the root-mean-square (RMS) power mean from a magnitude spectrum (either from an incoming UAna, or given manually), and outputs a single number.";
     if( !type_engine_import_uana_begin( env, "RMS", "UAna", env->global(),
                                         NULL, NULL,
     //---------------------------------------------------------------------
     // init as base class: RollOff
     //---------------------------------------------------------------------
     doc =
         "A unit analyzer that computes the spectral rolloff from a magnitude spectrum (either from incoming UAna, or given manually), and outputs a single number.";
     //---------------------------------------------------------------------
     // init as base class: AutoCorr
     //---------------------------------------------------------------------
+    doc =
+        "A unit analyzer that computes auto-correlation of the incoming analysis frame.";
     if( !type_engine_import_uana_begin( env, "AutoCorr", "UAna", env->global(),
                                         AutoCorr_ctor, AutoCorr_dtor,
-                                        AutoCorr_tick, AutoCorr_tock, AutoCorr_pmsg ) )
+                                        AutoCorr_tick, AutoCorr_tock, AutoCorr_pmsg,
+                                        CK_NO_VALUE, CK_NO_VALUE, CK_NO_VALUE, CK_NO_VALUE,
+                                        doc.c_str() ) )
         return FALSE;
     // data offset
     //---------------------------------------------------------------------
     // init as base class: XCorr
     //---------------------------------------------------------------------
+    doc =
+        "A unit analyzer that computes cross-correlation between two incoming analysis frames.";
     if( !type_engine_import_uana_begin( env, "XCorr", "UAna", env->global(),
                                         XCorr_ctor, XCorr_dtor,
-                                        XCorr_tick, XCorr_tock, XCorr_pmsg ) )
+                                        XCorr_tick, XCorr_tock, XCorr_pmsg,
+                                        CK_NO_VALUE, CK_NO_VALUE, CK_NO_VALUE, CK_NO_VALUE,
+                                        doc.c_str() ) )
         return FALSE;
     // data offset

src/core/uana_xform.cpp+8−0

     func->doc = "Manually take IFFT (as opposed to using .upchuck() / upchuck operator)";
     if( !type_engine_import_mfun( env, func ) ) goto error;
+    // add examples
+    if( !type_engine_import_add_ex( env, "analysis/ifft.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "analysis/ifft2.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "analysis/ifft3.ck" ) ) goto error;
     // end the class import
     type_engine_import_class_end( env );
     func->doc = "Manually take pilF (as opposed to using .upchuck() / upchuck operator)";
     if( !type_engine_import_mfun( env, func ) ) goto error;
+    // add example
+    if( !type_engine_import_add_ex( env, "analysis/flip.ck" ) ) goto error;
     // end the class import
     type_engine_import_class_end( env );

src/core/ugen_osc.cpp+5−3

     type_engine_import_class_end( env );
     //---------------------------------------------------------------------
-    // Warp
+    // WarpTable
     //---------------------------------------------------------------------
-    doc = "...";
+    doc = "An end-constrained mapping table, mostly useful for conditioning control signals.";
     if( !type_engine_import_ugen_begin( env, "WarpTable", "GenX", env->global(),
                                         NULL, NULL, genX_tick, NULL, doc.c_str() ) )
         return FALSE;
     if( !type_engine_import_mfun( env, func ) ) goto error;
     */
+    // add examples
+    if( !type_engine_import_add_ex( env, "special/GenX-WarpTable-test.ck" ) ) goto error;
     // end the class import
     type_engine_import_class_end( env );

src/core/ugen_stk.cpp+8−3

     // begin FM ugen
     //------------------------------------------------------------------------
-    doc = "STK FM synthesis super class.\n\
+    doc = "STK FM synthesis super class. You should NOT need to use this UGen directly. Please refer to the documentation on FM subclasses instead.\n\
 \n\
 This class controls an arbitrary number of waves and envelopes, determined via a constructor argument.\n\
 \n\
     if( !type_engine_import_ugen_begin( env, "FilterStk", "UGen", env->global(),
                         FilterStk_ctor, FilterStk_dtor,
-                        FilterStk_tick, FilterStk_pmsg ) ) return FALSE;
+                        FilterStk_tick, FilterStk_pmsg,
+                        "FilterStk is an STK Filter base class inherited by all Stk Filter UGens such as BiQuad, TwoZero, PoleZero, etc. You should NOT need to use this UGen directly. Please refer to the documentation on other filter types instead." ) ) return FALSE;
     // member variable
     FilterStk_offset_data = type_engine_import_mvar ( env, "int", "@FilterStk_data", FALSE );
     if( FilterStk_offset_data == CK_INVALID_OFFSET ) goto error;
     if( !type_engine_import_mfun( env, func ) ) goto error;
     // add examples
-    if( !type_engine_import_add_ex( env, "stk/chorus.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "effects/chorus.ck" ) ) goto error;
     // end the class import
     type_engine_import_class_end( env );
     func->doc = "get subsampling rate";
     if( !type_engine_import_mfun( env, func ) ) goto error;
+    // add examples
+    if( !type_engine_import_add_ex( env, "stk/subnoise-control.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "stk/subnoise-audio.ck" ) ) goto error;
     // end the class import
     type_engine_import_class_end( env );

src/core/ugen_xxx.cpp+3−1

     Multiple voice facility is built in, allowing for a single\
     LiSa object to serve as a source for sample layering and\
     granular textures.\
-    by Dan Trueman (2007)";
+    by Dan Trueman (2007)\n\
+    See also: a slowly growing <a target=\"_blank\" href=\"../program/lisa/tutorial-1.html\">tutorial</a>\
+    | <a target=\"_blank\" href=\"../examples/#lisa\">LiSa examples</a> in the ChucK distribution | <a target=\"_blank\" href=\"https://www.youtube.com/watch?v=7F75v_73pF4\">video tutorial</a> by Clint Hoagland.";
     if( !type_engine_import_ugen_begin( env, "LiSa", "UGen", env->global(),
                                         LiSaMulti_ctor, LiSaMulti_dtor,
                                         LiSaMulti_tick, NULL,

src/core/ulib_doc.cpp+2−2

@@ -305,8 +305,8 @@ public: · 304 unmodified lines
305	{	305	{
306	m_outputStr += "<a name=\"top\"/>\n";	306	m_outputStr += "<a name=\"top\"/>\n";
307	m_outputStr += "<div id=\"title\">\n";	307	m_outputStr += "<div id=\"title\">\n";
308	m_outputStr += "<div class=\"titleL\"><h1>" + m_title + "</h1></div>\n";	308	m_outputStr += "<div class=\"titleL\"><h1><a href=\"./\">ChucK Class Library Reference</a></h1></div>\n";
309	m_outputStr += "<div class=\"titleR\"><h1><a href=\"index.html\">ChucK Class Library Reference</a></h1></div>\n";	309	m_outputStr += "<h1>  <span style=\"color:black\">/</span>  " + m_title + "</h1></div>\n";
310	m_outputStr += "</div>\n"; // #title	310	m_outputStr += "</div>\n"; // #title
311	}	311	}
312		312

src/core/ulib_std.cpp+13−3

 #ifndef __DISABLE_PROMPTER__
     // begin class (Skot)
     if( !type_engine_import_class_begin( env, "ConsoleInput", "Event",
-                                         env->global(), Skot_ctor,
+                                         env->global(), Skot_ctor, Skot_dtor,
-                                         Skot_dtor ) )
+                                         "(Terminal only) a utility for prompting user input on the command line." ) )
         return FALSE;
     // add member variable
     // add prompt()
     func = make_new_mfun( "Event", "prompt", Skot_prompt );
+    func->doc = "Return an Event to wait on.";
     if( !type_engine_import_mfun( env, func ) ) goto error;
     // add prompt()
     func = make_new_mfun( "Event", "prompt", Skot_prompt2 );
     func->add_arg( "string", "what" );
+    func->doc = "Print a prompt text and return an Event to wait on.";
     if( !type_engine_import_mfun( env, func ) ) goto error;
-    // add ready()
+    // add more()
     func = make_new_mfun( "int", "more", Skot_more );
+    func->doc = "Return whether there is more input to read.";
     if( !type_engine_import_mfun( env, func ) ) goto error;
     // add getString()
     func = make_new_mfun( "string", "getLine", Skot_getLine );
+    func->doc = "Return the next line of input as a string.";
     if( !type_engine_import_mfun( env, func ) ) goto error;
     // add can_wait()
     func = make_new_mfun( "int", "can_wait", Skot_can_wait );
+    func->doc = "(internal) used by virtual machine for synthronization.";
     if( !type_engine_import_mfun( env, func ) ) goto error;
+    // add examples
+    if( !type_engine_import_add_ex( env, "string/readline.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "ai/word2vec/word2vec-prompt.ck" ) ) goto error;
+    if( !type_engine_import_add_ex( env, "ai/word2vec/poem-ungenerate.ck" ) ) goto error;
     // end class
     type_engine_import_class_end( env );
 #endif // __DISABLE_PROMPTER__

src/scripts/ckdoc/gen-all.ck+2−2

@@ -123,12 +123,12 @@ doc.addGroup( · 122 unmodified lines
123		123
124	// add group	124	// add group
125	doc.addGroup(	125	doc.addGroup(
126	[ "IO", "FileIO", "StdOut", "StdErr",	126	[ "IO", "FileIO", /* "StdOut", "StdErr", */
127	"OscIn", "OscOut", "OscMsg",	127	"OscIn", "OscOut", "OscMsg",
128	"Hid", "HidMsg", "SerialIO",	128	"Hid", "HidMsg", "SerialIO",
129	"MidiIn", "MidiOut", "MidiMsg", "MidiFileIn" ],	129	"MidiIn", "MidiOut", "MidiMsg", "MidiFileIn" ],
130	// group name	130	// group name
131	"Input / Output",	131	"Input & Output",
132	// file name	132	// file name
133	"io",	133	"io",
134	// group descriptions	134	// group descriptions

new ckdoc title rendering

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code