summaryrefslogtreecommitdiff
path: root/public/fpdf_searchex.h
diff options
context:
space:
mode:
authordsinclair <dsinclair@chromium.org>2016-04-25 19:44:20 -0700
committerCommit bot <commit-bot@chromium.org>2016-04-25 19:44:21 -0700
commit860193b775f19a176963e31d41f641455499fccb (patch)
treeb32745a7447b29daef256bbfbf9651b5e4a1ed11 /public/fpdf_searchex.h
parent1f5f2fff688f4075a62c87a032c9a9070bde89fc (diff)
downloadpdfium-860193b775f19a176963e31d41f641455499fccb.tar.xz
Continue documentation cleanup
Reformat some more public/ header documentation. Review URL: https://codereview.chromium.org/1917103002
Diffstat (limited to 'public/fpdf_searchex.h')
-rw-r--r--public/fpdf_searchex.h21
1 files changed, 9 insertions, 12 deletions
diff --git a/public/fpdf_searchex.h b/public/fpdf_searchex.h
index a6b6e1bdbf..0d90bdddb9 100644
--- a/public/fpdf_searchex.h
+++ b/public/fpdf_searchex.h
@@ -11,22 +11,19 @@
#ifdef __cplusplus
extern "C" {
-#endif
+#endif // __cplusplus
-// Function: FPDFText_GetCharIndexFromTextIndex
-// Get the actually char index in text_page's internal char list.
-// Parameters:
-// text_page - Handle to a text page information structure.
-// Returned by FPDFText_LoadPage function.
-// nTextIndex - The index of the text in the string get from
-// FPDFText_GetText.
-// Return value:
-// The index of the character in internal charlist. -1 for error.
+// Get the character index in |text_page| internal character list.
+//
+// text_page - a text page information structure.
+// nTextIndex - index of the text returned from |FPDFText_GetText|.
+//
+// Returns the index of the character in internal character list. -1 for error.
DLLEXPORT int STDCALL
FPDFText_GetCharIndexFromTextIndex(FPDF_TEXTPAGE text_page, int nTextIndex);
#ifdef __cplusplus
-}
-#endif
+} // extern "C"
+#endif // __cplusplus
#endif // PUBLIC_FPDF_SEARCHEX_H_