chenx221/Textractor
1
0
Fork 0
forked from Public-Mirror/Textractor
Code Pull Requests Activity

update docs

Browse Source
This commit is contained in:
Akash Mozumdar 2019-02-09 00:34:14 -05:00
parent a07e10344f
commit cf34160bbe
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
extensions/extensionimpl.cpp
View File

@ -5,9 +5,9 @@ bool ProcessSentence(std::wstring& sentence, SentenceInfo sentenceInfo);
/** /**
* You shouldn't mess with this or even look at it unless you're certain you know what you're doing. * You shouldn't mess with this or even look at it unless you're certain you know what you're doing.
* Param sentence: pointer to sentence received by Textractor (UTF-16). * Param sentence: pointer to sentence received by Textractor (UTF-16).
* You should not modify this sentence. If you want Textractor to receive a modified sentence, copy it into your own buffer and return that. * You should not write beyond the end of this sentence. If you want Textractor to receive a larger 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. * 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. * Param miscInfo: pointer to array containing misc info about the sentence. End of array is marked with name being nullptr.
* Return value: pointer to sentence Textractor takes for future processing and display. If nullptr, Textractor will destroy 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. * 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. * Textractor will display the sentence after all extensions have had a chance to process and/or modify it.