Add function comments to IsMailAddress/IsURL.

sakura_core/parse/CWordParse.h

@@ -125,17 +125,42 @@ class CWordParse{
 	static bool _match_charlist( const WCHAR c, const WCHAR *pszList );
 };
 
-BOOL IsURL( const wchar_t* psz, int offset, int length, int* outLength);/* offset 引数の追加により境界判定が行える高速版 */
+/** 指定アドレスが URL の先頭ならば TRUE とその長さを返す。
+    @param[in]  pszBuffer       文字列バッファの先頭アドレス
+    @param[in]  offset          URL 判定開始位置を示す、pszBuffer からの相対位置。
+    @param[in]  nBufLen         URL 判定終了位置を示す、pszBuffer からの相対位置。
+    @param[out] pnAddressLength URL の長さを受け取る変数のアドレス。長さとは pszBuffer + offset からの距離。
+
+    offset 引数は IsMailAddress に渡すためにだけ使用されます。
+*/
+BOOL IsURL( const wchar_t* pszBuffer, int offset, int nBufLen, int* pnAddressLength);
+
+/** 互換性のために残されています。offset 引数が追加されたものを使用してください。
+*/
 inline
-BOOL IsURL( const wchar_t* psz, int length, int* outLength) /* 指定アドレスがURLの先頭ならばTRUEとその長さを返す。高速版の追加により obsolete. */
+BOOL IsURL( const wchar_t* pszBuffer, int nBufLen, int* pnAddressLength)
 {
-	return IsURL(psz, 0, length, outLength);
+	return IsURL(pszBuffer, 0, nBufLen, pnAddressLength);
 }
-BOOL IsMailAddress( const wchar_t* psz, int offset, int length, int* outLength); /* offset 引数の追加により境界判定が行える高速版 */
+
+/** 指定アドレスがメールアドレスの先頭ならば TRUE とその長さを返す。
+    @param[in]  pszBuffer       文字列バッファの先頭アドレス
+    @param[in]  offset          メールアドレス判定開始位置を示す、pszBuffer からの相対位置。
+    @param[in]  nBufLen         メールアドレス判定終了位置を示す、pszBuffer からの相対位置。
+    @param[out] pnAddressLength メールアドレスの長さを受け取る変数のアドレス。長さとは pszBuffer + offset からの距離。
+
+    正の offset が与えられた場合は判定開始位置直前の文字との間で境界判定を行います。
+    途中から切り出したメールアドレスの一部をメールアドレスであると誤って判定しないために
+    pszBuffer を固定し offset を０以上の範囲で変化させるのが望ましい使用方法です。
+*/
+BOOL IsMailAddress( const wchar_t* pszBuffer, int offset, int nBufLen, int* pnAddressLength);
+
+/** 互換性のために残されています。offset 引数が追加されたものを使用してください。
+*/
 inline
-BOOL IsMailAddress( const wchar_t* psz, int length, int* outLength) /* 現在位置がメールアドレスならば、NULL以外と、その長さを返す。高速版の追加により obsolete. */
+BOOL IsMailAddress( const wchar_t* pszBuffer, int nBufLen, int* pnAddressLength)
 {
-	return IsMailAddress(psz, 0, length, outLength);
+	return IsMailAddress(pszBuffer, 0, nBufLen, pnAddressLength);
 }
 
 // ACHAR 版