Patchwork [11/13] fedfsc: Finish adding Doxygen comments in the ADMIN client code

login
register
mail settings
Submitter Chuck Lever
Date Feb. 1, 2013, 5:21 p.m.
Message ID <20130201172120.63192.8166.stgit@seurat.1015granger.net>
Download mbox | patch
Permalink /patch/217538/
State Accepted
Headers show

Comments

Chuck Lever - Feb. 1, 2013, 5:21 p.m.
These have been missing since commit 0520ee72 "Initial commit", Tue
Mar 29 15:37:40 2011.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 src/fedfsc/fedfs-create-junction.c         |    8 ++-
 src/fedfsc/fedfs-create-replication.c      |   23 +++++++++
 src/fedfsc/fedfs-delete-junction.c         |   20 ++++++++
 src/fedfsc/fedfs-delete-replication.c      |   20 ++++++++
 src/fedfsc/fedfs-get-limited-nsdb-params.c |   26 ++++++++++
 src/fedfsc/fedfs-get-nsdb-params.c         |   28 +++++++++++
 src/fedfsc/fedfs-lookup-junction.c         |   70 ++++++++++++++++++++++++++++
 src/fedfsc/fedfs-lookup-replication.c      |   70 ++++++++++++++++++++++++++++
 src/fedfsc/fedfs-null.c                    |   19 ++++++++
 src/fedfsc/fedfs-set-nsdb-params.c         |   29 ++++++++++++
 10 files changed, 309 insertions(+), 4 deletions(-)

Patch

diff --git a/src/fedfsc/fedfs-create-junction.c b/src/fedfsc/fedfs-create-junction.c
index 8eb4c15..0d6ce2d 100644
--- a/src/fedfsc/fedfs-create-junction.c
+++ b/src/fedfsc/fedfs-create-junction.c
@@ -96,15 +96,15 @@  fedfs_create_junction_usage(const char *progname)
 }
 
 /**
- * Create a junction on a remote server
+ * Create a junction on a remote fileserver
  *
  * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
  * @param nettype NUL-terminated C string containing nettype to use for connection
  * @param path NUL-terminated C string containing remote pathname of new junction
  * @param uuid NUL-terminated C string containing FSN UUID for new junction
- * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB service for this junction
- * @param nsdbport port number of NSDB service for this junction
- * @return an exit status value
+ * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB node for this junction
+ * @param nsdbport port number of NSDB node for this junction
+ * @return a FedFsStatus code
  */
 static FedFsStatus
 fedfs_create_junction_call(const char *hostname, const char *nettype,
diff --git a/src/fedfsc/fedfs-create-replication.c b/src/fedfsc/fedfs-create-replication.c
index 6aef3ce..3267627 100644
--- a/src/fedfsc/fedfs-create-replication.c
+++ b/src/fedfsc/fedfs-create-replication.c
@@ -66,6 +66,11 @@  static const struct option fedfs_create_replication_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_create_replication_usage(const char *progname)
 {
@@ -87,6 +92,17 @@  fedfs_create_replication_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Create a replication on a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param path NUL-terminated C string containing remote pathname of new replication
+ * @param uuid NUL-terminated C string containing FSN UUID for new replication
+ * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB node for this replication
+ * @param nsdbport port number of NSDB node for this replication
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_create_replication_call(const char *hostname, const char *nettype,
 		const char *path, const char *uuid, char *nsdbname,
@@ -155,6 +171,13 @@  out:
 	return result;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-delete-junction.c b/src/fedfsc/fedfs-delete-junction.c
index ba8d0c4..f2085c5 100644
--- a/src/fedfsc/fedfs-delete-junction.c
+++ b/src/fedfsc/fedfs-delete-junction.c
@@ -63,6 +63,11 @@  static const struct option fedfs_delete_junction_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_delete_junction_usage(const char *progname)
 {
@@ -80,6 +85,14 @@  fedfs_delete_junction_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Delete a junction on a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param path NUL-terminated C string containing remote pathname of junction to delete
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_delete_junction_call(const char *hostname, const char *nettype,
 		const char *path)
@@ -132,6 +145,13 @@  out:
 	return result;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-delete-replication.c b/src/fedfsc/fedfs-delete-replication.c
index f872da4..ee0a6bd 100644
--- a/src/fedfsc/fedfs-delete-replication.c
+++ b/src/fedfsc/fedfs-delete-replication.c
@@ -63,6 +63,11 @@  static const struct option fedfs_delete_replication_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_delete_replication_usage(const char *progname)
 {
@@ -80,6 +85,14 @@  fedfs_delete_replication_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Delete a replication on a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param path NUL-terminated C string containing remote pathname of replication to delete
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_delete_replication_call(const char *hostname, const char *nettype,
 		const char *path)
@@ -132,6 +145,13 @@  out:
 	return result;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-get-limited-nsdb-params.c b/src/fedfsc/fedfs-get-limited-nsdb-params.c
index 7bfb535..59c3035 100644
--- a/src/fedfsc/fedfs-get-limited-nsdb-params.c
+++ b/src/fedfsc/fedfs-get-limited-nsdb-params.c
@@ -67,6 +67,11 @@  static const struct option fedfs_get_limited_nsdb_params_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_get_limited_nsdb_params_usage(const char *progname)
 {
@@ -86,6 +91,11 @@  fedfs_get_limited_nsdb_params_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Display NSDB information
+ *
+ * @param result NSDB information to display
+ */
 static void
 fedfs_get_limited_nsdb_params_print_result(FedFsGetNsdbParamsRes result)
 {
@@ -113,6 +123,15 @@  fedfs_get_limited_nsdb_params_print_result(FedFsGetNsdbParamsRes result)
 	}
 }
 
+/**
+ * Retrieve limited NSDB information from a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB node to retrieve
+ * @param nsdbport port number of NSDB node to retrieve
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_get_limited_nsdb_params_call(const char *hostname, const char *nettype,
 		char *nsdbname, const unsigned short nsdbport)
@@ -155,6 +174,13 @@  out:
 	return result.status;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-get-nsdb-params.c b/src/fedfsc/fedfs-get-nsdb-params.c
index 459c56d..a77cf88 100644
--- a/src/fedfsc/fedfs-get-nsdb-params.c
+++ b/src/fedfsc/fedfs-get-nsdb-params.c
@@ -68,6 +68,11 @@  static const struct option fedfs_get_nsdb_params_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_get_nsdb_params_usage(const char *progname)
 {
@@ -89,6 +94,12 @@  fedfs_get_nsdb_params_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Display NSDB information
+ *
+ * @param result NSDB information to display
+ * @param certfile NUL-terminated UTF-8 string containing pathname of file to write security data to
+ */
 static void
 fedfs_get_nsdb_params_print_result(FedFsGetNsdbParamsRes result,
 		const char *certfile)
@@ -121,6 +132,16 @@  fedfs_get_nsdb_params_print_result(FedFsGetNsdbParamsRes result,
 	}
 }
 
+/**
+ * Retrieve NSDB information from a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB node to retrieve
+ * @param nsdbport port number of NSDB node to retrieve
+ * @param certfile NUL-terminated UTF-8 string containing pathname of file to write security data to
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_get_nsdb_params_call(const char *hostname, const char *nettype,
 		char *nsdbname, const unsigned short nsdbport,
@@ -164,6 +185,13 @@  out:
 	return result.status;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-lookup-junction.c b/src/fedfsc/fedfs-lookup-junction.c
index 659665b..f62691e 100644
--- a/src/fedfsc/fedfs-lookup-junction.c
+++ b/src/fedfsc/fedfs-lookup-junction.c
@@ -66,6 +66,11 @@  static const struct option fedfs_lookup_junction_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_lookup_junction_usage(const char *progname)
 {
@@ -84,6 +89,13 @@  fedfs_lookup_junction_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Parse name of resolvetype to resolvetype number
+ *
+ * @param resolvetype NUL-terminated C string containing name of requested resolvetype
+ * @param resolve OUT: resolvetype number
+ * @return true if "resolvetype" is a valid resolvetype
+ */
 static _Bool
 fedfs_lookup_junction_get_resolvetype(const char *resolvetype, FedFsResolveType *resolve)
 {
@@ -108,6 +120,12 @@  fedfs_lookup_junction_get_resolvetype(const char *resolvetype, FedFsResolveType
 	return false;
 }
 
+/**
+ * Display FSN UUID information in a FEDFS_LOOKUP_JUNCTION result
+ *
+ * @param pre_text NUL-terminated C string containing prefix to display
+ * @param uuid UUID to display
+ */
 static void
 fedfs_lookup_junction_print_uuid(const char *pre_text, const FedFsUuid uuid)
 {
@@ -119,6 +137,12 @@  fedfs_lookup_junction_print_uuid(const char *pre_text, const FedFsUuid uuid)
 	printf("%s: %s\n", pre_text, buf);
 }
 
+/**
+ * Display FSN NSDB information in a FEDFS_LOOKUP_JUNCTION result
+ *
+ * @param pre_text NUL-terminated C string containing prefix to display
+ * @param nsdbname NSDB information to display
+ */
 static void
 fedfs_lookup_junction_print_nsdbname(const char *pre_text,
 		const FedFsNsdbName nsdbname)
@@ -133,6 +157,11 @@  fedfs_lookup_junction_print_nsdbname(const char *pre_text,
 		nsdbname.port);
 }
 
+/**
+ * Display FSN information in a FEDFS_LOOKUP_JUNCTION result
+ *
+ * @param fsn FSN information to display
+ */
 static void
 fedfs_lookup_junction_print_fsn(const FedFsFsn fsn)
 {
@@ -140,6 +169,11 @@  fedfs_lookup_junction_print_fsn(const FedFsFsn fsn)
 	fedfs_lookup_junction_print_nsdbname("NSDB", fsn.nsdbName);
 }
 
+/**
+ * Display one NFS FSL in a FEDFS_LOOKUP_JUNCTION result
+ *
+ * @param fsl FSL record to display
+ */
 static void
 fedfs_lookup_junction_print_nfs_fsl(FedFsNfsFsl fsl)
 {
@@ -173,6 +207,11 @@  fedfs_lookup_junction_print_nfs_fsl(FedFsNfsFsl fsl)
 	}
 }
 
+/**
+ * Display one FSL in a FEDFS_LOOKUP_JUNCTION result
+ *
+ * @param fsl FSL record to display
+ */
 static void
 fedfs_lookup_junction_print_fsl(FedFsFsl fsl)
 {
@@ -185,6 +224,11 @@  fedfs_lookup_junction_print_fsl(FedFsFsl fsl)
 	}
 }
 
+/**
+ * Display results of a successful FEDFS_LOOKUP_JUNCTION request
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_junction_print_resok(FedFsLookupResOk result)
 {
@@ -200,6 +244,11 @@  fedfs_lookup_junction_print_resok(FedFsLookupResOk result)
 		fedfs_lookup_junction_print_fsl(result.fsl.fsl_val[i]);
 }
 
+/**
+ * Display results of FEDFS_LOOKUP_JUNCTION when an LDAP/NSDB failure is reported
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_junction_print_ldapresultcode(FedFsLookupRes result)
 {
@@ -209,6 +258,11 @@  fedfs_lookup_junction_print_ldapresultcode(FedFsLookupRes result)
 		ldap_err, ldap_err2string(ldap_err));
 }
 
+/**
+ * Display results of FEDFS_LOOKUP_JUNCTION request
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_junction_print_result(FedFsLookupRes result)
 {
@@ -225,6 +279,15 @@  fedfs_lookup_junction_print_result(FedFsLookupRes result)
 	}
 }
 
+/**
+ * Request a remote fileserver to resolve a junction
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param path NUL-terminated C string containing remote pathname of junction to resolve
+ * @param resolvetype NUL-terminated C string containing name of requested resolvetype
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_lookup_junction_call(const char *hostname, const char *nettype,
 		const char *path, const char *resolvetype)
@@ -284,6 +347,13 @@  out:
 	exit(result.status);
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-lookup-replication.c b/src/fedfsc/fedfs-lookup-replication.c
index 2e2332c..a845b32 100644
--- a/src/fedfsc/fedfs-lookup-replication.c
+++ b/src/fedfsc/fedfs-lookup-replication.c
@@ -66,6 +66,11 @@  static const struct option fedfs_lookup_replication_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_lookup_replication_usage(const char *progname)
 {
@@ -84,6 +89,13 @@  fedfs_lookup_replication_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Parse name of resolvetype to resolvetype number
+ *
+ * @param resolvetype NUL-terminated C string containing name of requested resolvetype
+ * @param resolve OUT: resolvetype number
+ * @return true if "resolvetype" is a valid resolvetype
+ */
 static _Bool
 fedfs_lookup_replication_get_resolvetype(const char *resolvetype, FedFsResolveType *resolve)
 {
@@ -108,6 +120,12 @@  fedfs_lookup_replication_get_resolvetype(const char *resolvetype, FedFsResolveTy
 	return false;
 }
 
+/**
+ * Display FSN UUID information in a FEDFS_LOOKUP_REPLICATION result
+ *
+ * @param pre_text NUL-terminated C string containing prefix to display
+ * @param uuid UUID to display
+ */
 static void
 fedfs_lookup_replication_print_uuid(const char *pre_text, const FedFsUuid uuid)
 {
@@ -119,6 +137,12 @@  fedfs_lookup_replication_print_uuid(const char *pre_text, const FedFsUuid uuid)
 	printf("%s: %s\n", pre_text, buf);
 }
 
+/**
+ * Display FSN NSDB information in a FEDFS_LOOKUP_REPLICATION result
+ *
+ * @param pre_text NUL-terminated C string containing prefix to display
+ * @param nsdbname NSDB information to display
+ */
 static void
 fedfs_lookup_replication_print_nsdbname(const char *pre_text,
 		const FedFsNsdbName nsdbname)
@@ -133,6 +157,11 @@  fedfs_lookup_replication_print_nsdbname(const char *pre_text,
 		nsdbname.port);
 }
 
+/**
+ * Display FSN information in a FEDFS_LOOKUP_REPLICATION result
+ *
+ * @param fsn FSN information to display
+ */
 static void
 fedfs_lookup_replication_print_fsn(const FedFsFsn fsn)
 {
@@ -140,6 +169,11 @@  fedfs_lookup_replication_print_fsn(const FedFsFsn fsn)
 	fedfs_lookup_replication_print_nsdbname("Fsn NSDB name", fsn.nsdbName);
 }
 
+/**
+ * Display one NFS FSL in a FEDFS_LOOKUP_REPLICATION result
+ *
+ * @param fsl FSL record to display
+ */
 static void
 fedfs_lookup_replication_print_nfs_fsl(FedFsNfsFsl fsl)
 {
@@ -173,6 +207,11 @@  fedfs_lookup_replication_print_nfs_fsl(FedFsNfsFsl fsl)
 	}
 }
 
+/**
+ * Display one FSL in a FEDFS_LOOKUP_REPLICATION result
+ *
+ * @param fsl FSL record to display
+ */
 static void
 fedfs_lookup_replication_print_fsl(FedFsFsl fsl)
 {
@@ -185,6 +224,11 @@  fedfs_lookup_replication_print_fsl(FedFsFsl fsl)
 	}
 }
 
+/**
+ * Display results of a successful FEDFS_LOOKUP_REPLICATION request
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_replication_print_resok(FedFsLookupResOk result)
 {
@@ -201,6 +245,11 @@  fedfs_lookup_replication_print_resok(FedFsLookupResOk result)
 		fedfs_lookup_replication_print_fsl(result.fsl.fsl_val[i]);
 }
 
+/**
+ * Display results of FEDFS_LOOKUP_REPLICATION when an LDAP/NSDB failure is reported
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_replication_print_ldapresultcode(FedFsLookupRes result)
 {
@@ -210,6 +259,11 @@  fedfs_lookup_replication_print_ldapresultcode(FedFsLookupRes result)
 		ldap_err, ldap_err2string(ldap_err));
 }
 
+/**
+ * Display results of FEDFS_LOOKUP_JUNCTION request
+ *
+ * @param result results to display
+ */
 static void
 fedfs_lookup_replication_print_result(FedFsLookupRes result)
 {
@@ -226,6 +280,15 @@  fedfs_lookup_replication_print_result(FedFsLookupRes result)
 	}
 }
 
+/**
+ * Request a remote fileserver to resolve a replication
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param path NUL-terminated C string containing remote pathname of replication to resolve
+ * @param resolvetype NUL-terminated C string containing name of requested resolvetype
+ * @return a FedFsStatus code
+ */
 static int
 fedfs_lookup_replication_call(const char *hostname, const char *nettype,
 		const char *path, const char *resolvetype)
@@ -285,6 +348,13 @@  out:
 	return result.status;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-null.c b/src/fedfsc/fedfs-null.c
index d8de92d..05cf9a9 100644
--- a/src/fedfsc/fedfs-null.c
+++ b/src/fedfsc/fedfs-null.c
@@ -60,6 +60,11 @@  static const struct option fedfs_null_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_null_usage(const char *progname)
 {
@@ -78,6 +83,13 @@  fedfs_null_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Send a NULL ADMIN request (ping) to a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_null_call(const char *hostname, const char *nettype)
 {
@@ -108,6 +120,13 @@  fedfs_null_call(const char *hostname, const char *nettype)
 	return exit_status;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {
diff --git a/src/fedfsc/fedfs-set-nsdb-params.c b/src/fedfsc/fedfs-set-nsdb-params.c
index ca88ef1..783f045 100644
--- a/src/fedfsc/fedfs-set-nsdb-params.c
+++ b/src/fedfsc/fedfs-set-nsdb-params.c
@@ -68,6 +68,11 @@  static const struct option fedfs_set_nsdb_params_longopts[] = {
 	{ NULL, 0, NULL, 0, },
 };
 
+/**
+ * Display program synopsis
+ *
+ * @param progname NUL-terminated C string containing name of program
+ */
 static void
 fedfs_set_nsdb_params_usage(const char *progname)
 {
@@ -89,6 +94,13 @@  fedfs_set_nsdb_params_usage(const char *progname)
 	exit((int)FEDFS_ERR_INVAL);
 }
 
+/**
+ * Construct connection parameters argument
+ *
+ * @param certfile NUL-terminated UTF-8 string containing pathname of file containing security data to send
+ * @param params OUT: filled-in NSDB connection parameters to send
+ * @result true if construction was successful
+ */
 static _Bool
 fedfs_set_nsdb_params_get_params(const char *certfile, FedFsNsdbParams *params)
 {
@@ -120,6 +132,16 @@  fedfs_set_nsdb_params_get_params(const char *certfile, FedFsNsdbParams *params)
 	return true;
 }
 
+/**
+ * Set NSDB connection parameters on a remote fileserver
+ *
+ * @param hostname NUL-terminated UTF-8 string containing ADMIN server's hostname
+ * @param nettype NUL-terminated C string containing nettype to use for connection
+ * @param nsdbname NUL-terminated UTF-8 string containing name of NSDB node to set
+ * @param nsdbport port number of NSDB node to set
+ * @param certfile NUL-terminated UTF-8 string containing pathname of file containing security data to send
+ * @return a FedFsStatus code
+ */
 static FedFsStatus
 fedfs_set_nsdb_params_call(const char *hostname, const char *nettype,
 		char *nsdbname, const unsigned short nsdbport,
@@ -163,6 +185,13 @@  out:
 	return result;
 }
 
+/**
+ * Program entry point
+ *
+ * @param argc count of command line arguments
+ * @param argv array of NUL-terminated C strings containing command line arguments
+ * @return program exit status
+ */
 int
 main(int argc, char **argv)
 {