Showing the changes to src/core/chuck_io.cpp (1 of 9 files). Show all
Unified · Split
| @@ -93,7 +93,7 @@ t_CKBOOL init_class_io( Chuck_Env * env, Chuck_Type * type ) · 92 unmodified lines | ||
| 93 | 93 | { |
| 94 | 94 | // init as base class |
| 95 | 95 | Chuck_DL_Func * func = NULL; |
| 96 | − std::string doc = ""; | |
| 96 | + 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."; | |
| 97 | 97 | |
| 98 | 98 | // log |
| 99 | 99 | EM_log( CK_LOG_SEVERE, "class 'IO'" ); |
| @@ -272,7 +272,8 @@ t_CKBOOL init_class_fileio( Chuck_Env * env, Chuck_Type * type ) · 172 unmodified lines | ||
| 272 | 272 | // init as base class |
| 273 | 273 | // TODO: ctor/dtor? |
| 274 | 274 | // TODO: replace dummy with pure function |
| 275 | − if( !type_engine_import_class_begin( env, type, env->global(), fileio_ctor, fileio_dtor ) ) | |
| 275 | + if( !type_engine_import_class_begin( env, type, env->global(), fileio_ctor, fileio_dtor, | |
| 276 | + "Helper class doing file-related operations such as reading, writing, seeking, etc. See examples for usage." ) ) | |
| 276 | 277 | return FALSE; |
| 277 | 278 | |
| 278 | 279 | // add open(string) |
| @@ -444,7 +445,7 @@ t_CKBOOL init_class_chout( Chuck_Env * env, Chuck_Type * type ) · 165 unmodified lines | ||
| 444 | 445 | EM_log( CK_LOG_SEVERE, "class 'chout'" ); |
| 445 | 446 | |
| 446 | 447 | // TODO: ctor/dtor? |
| 447 | − if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL ) ) | |
| 448 | + if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, "Do not instantiate this class directly! Use `chout` instead." ) ) | |
| 448 | 449 | return FALSE; |
| 449 | 450 | |
| 450 | 451 | // add good() |
| @@ -537,7 +538,7 @@ t_CKBOOL init_class_cherr( Chuck_Env * env, Chuck_Type * type ) · 86 unmodified lines | ||
| 537 | 538 | EM_log( CK_LOG_SEVERE, "class 'cherr'" ); |
| 538 | 539 | |
| 539 | 540 | // TODO: ctor/dtor? |
| 540 | − if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL ) ) | |
| 541 | + if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, "Do not instantiate this class directly! Use `cherr` instead." ) ) | |
| 541 | 542 | return FALSE; |
| 542 | 543 | |
| 543 | 544 | // add good() |