From 860193b775f19a176963e31d41f641455499fccb Mon Sep 17 00:00:00 2001 From: dsinclair Date: Mon, 25 Apr 2016 19:44:20 -0700 Subject: Continue documentation cleanup Reformat some more public/ header documentation. Review URL: https://codereview.chromium.org/1917103002 --- public/fpdf_searchex.h | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) (limited to 'public/fpdf_searchex.h') 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_ -- cgit v1.2.3