From 4aa91755ed2f900b07fa9a661f2e96081e536a54 Mon Sep 17 00:00:00 2001 From: kevin Date: Sat, 10 Feb 2024 11:35:34 -0500 Subject: [PATCH] cwMidiDecls.h,cwMidiFile.h,cwThread.h : Fixed or improved comments. No functional changes. --- cwMidiDecls.h | 2 +- cwMidiFile.h | 4 ++-- cwThread.h | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/cwMidiDecls.h b/cwMidiDecls.h index 3400d66..9e456fb 100644 --- a/cwMidiDecls.h +++ b/cwMidiDecls.h @@ -16,7 +16,7 @@ namespace cw typedef struct packet_str { - void* cbDataPtr; // Application supplied reference value from mdParserCreate() + void* cbDataPtr; // Application supplied reference value unsigned devIdx; // The device the msg originated from unsigned portIdx; // The port index on the source device msg_t* msgArray; // Pointer to an array of 'msgCnt' mdMsg records or NULL if sysExMsg is non-NULL diff --git a/cwMidiFile.h b/cwMidiFile.h index 8e1ace9..602f03c 100644 --- a/cwMidiFile.h +++ b/cwMidiFile.h @@ -152,7 +152,7 @@ namespace cw const trackMsg_t* trackMsg( handle_t h, unsigned trackIdx ); // Returns the total count of records in the midi file and the - // number in the array returned by cmMidiFileMsgArray(). + // number in the array returned by msgArray(). // Return kInvalidCnt if 'h' is invalid. unsigned msgCount( handle_t h ); @@ -221,7 +221,7 @@ namespace cw rc_t genCsvFile( const char* midiFn, const char* csvFn, bool printWarningsFl=true ); - // Generate a text file reportusing cmMIdiFilePrintMsgs() + // Generate a text file report using printMsgs() rc_t report( const char* midiFn, log::handle_t logH ); rc_t report_begin_end( const char* midiFn, unsigned msg_cnt=10, bool pitch_only_fl=true, log::handle_t logH=log::handle_t() ); diff --git a/cwThread.h b/cwThread.h index 287dbc8..0346cb7 100644 --- a/cwThread.h +++ b/cwThread.h @@ -15,10 +15,12 @@ namespace cw typedef handle handle_t; + // Return false to indicate that the thread should terminate. typedef bool (*cbFunc_t)( void* arg ); typedef unsigned long long thread_id_t; + // The thread is in the 'paused' state after it is created. // stateMicros = total time out duration for switching to the exit state or for switching in/out of pause state. // pauseMicros = duration of thread sleep interval when in paused state. rc_t create( handle_t& hRef, cbFunc_t func, void* funcArg, int stateTimeOutMicros=100000, int pauseMicros=10000 );