From 7304727c17ea01fc6d08d895b8be8ab2bb9ee1cf Mon Sep 17 00:00:00 2001 From: Akash Mozumdar Date: Wed, 10 Oct 2018 06:16:47 -0400 Subject: [PATCH] better comment --- extensions/extensions.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extensions/extensions.h b/extensions/extensions.h index f01f3dd..9b6e769 100644 --- a/extensions/extensions.h +++ b/extensions/extensions.h @@ -33,7 +33,7 @@ bool ProcessSentence(std::wstring& sentence, SentenceInfo sentenceInfo); * You should not modify this sentence. If you want Textractor to receive a modified sentence, copy it into your own buffer and return that. * Please allocate the buffer using HeapAlloc() and not new[] or malloc() or something else: Textractor uses HeapFree() to free it. * Param miscInfo: pointer to start of singly linked list containing misc info about the sentence. - * Return value: pointer to sentence Textractor takes for future processing and display. If nullptr, Textractor will 'eat' the sentence. + * Return value: pointer to sentence Textractor takes for future processing and display. If nullptr, Textractor will destroy the sentence. * Return 'sentence' unless you created a new sentence/buffer as mentioned above. * Textractor will display the sentence after all extensions have had a chance to process and/or modify it. * THIS FUNCTION MAY BE RUN SEVERAL TIMES CONCURRENTLY: PLEASE ENSURE THAT IT IS THREAD SAFE!