summaryrefslogtreecommitdiff
path: root/public/fpdf_formfill.h
diff options
context:
space:
mode:
authorTom Sepez <tsepez@chromium.org>2017-05-16 15:33:20 -0700
committerChromium commit bot <commit-bot@chromium.org>2017-05-16 23:26:47 +0000
commitfe91c6c8211cec39f871d9202556e1957bf81983 (patch)
treeb7e763f7affe4c71de67393fbd320c1fed477e0f /public/fpdf_formfill.h
parent365333552cf67b7c97c4093177e7ed7b43f540ab (diff)
downloadpdfium-fe91c6c8211cec39f871d9202556e1957bf81983.tar.xz
Be skeptical of bare |new|s.
In particular, prefer an explicit .release() call when handing ownership of an object to a caller across a C-API. Change-Id: Ic3784e9d0b2d378a08d388989eaea7c9166bacd1 Reviewed-on: https://pdfium-review.googlesource.com/5470 Commit-Queue: Tom Sepez <tsepez@chromium.org> Reviewed-by: Lei Zhang <thestig@chromium.org>
Diffstat (limited to 'public/fpdf_formfill.h')
-rw-r--r--public/fpdf_formfill.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/public/fpdf_formfill.h b/public/fpdf_formfill.h
index 09b80eaf90..65be850b36 100644
--- a/public/fpdf_formfill.h
+++ b/public/fpdf_formfill.h
@@ -1687,15 +1687,16 @@ FPDF_Widget_ReplaceSpellCheckWord(FPDF_DOCUMENT document,
/**
* Function: FPDF_Widget_GetSpellCheckWords
* This method will implement the spell check feature for the specified
- *xfa field.
+ * xfa field.
* Parameters:
- * document - Handle to document. Returned by
- *FPDF_LoadDocument function.
+ * document - Handle to document as returned by
+ * FPDF_LoadDocument function.
* hWidget - Handle to the xfa field.
* x - The x value of the specified point.
* y - The y value of the specified point.
* stringHandle - Pointer to FPDF_STRINGHANDLE to receive the
- *speck check text buffer, in UTF-16LE format.
+ * speck check text buffer, in UTF-16LE format.
+ * Caller must free using FPDF_StringHandleRelease.
* Return Value:
* None.
**/