Expand the pwqual_plugin.h documentation to tell module implementors

what a pwqual initvt function should look like.

git-svn-id: svn://anonsvn.mit.edu/krb5/branches/plugins2@24283 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/src/include/krb5/pwqual_plugin.h b/src/include/krb5/pwqual_plugin.h
index 61f8062774945d8c1c2172b22480b1ee99391fd9..403bb11521817c474a335ba1f1b8bbf9f2b1a52a 100644 (file)
--- a/src/include/krb5/pwqual_plugin.h
+++ b/src/include/krb5/pwqual_plugin.h
@@ -32,7 +32,13 @@
  * number of 1.
  *
  * Password quality plugin modules should define a function named
- * pwqual_<modulename>_initvt.  The initvt function should:
+ * pwqual_<modulename>_initvt, matching the signature:
+ *
+ *   krb5_error_code
+ *   pwqual_modname_initvt(krb5_context context, int maj_ver, int min_ver,
+ *                         krb5_plugin_vtable vtable);
+ *
+ * The initvt function should:
  *
  * - Check that the supplied maj_ver number is supported by the module, or
  *   return KRB5_PLUGIN_VER_NOTSUPP if it is not.