Document filter functions

Add documentation for the various filter functions.

Signed-off-by: Hannes Reinecke <[email protected]>

Author: hreinecke

src/nvme/filters.c

@@ -93,9 +93,9 @@ int nvme_scan_subsystems(struct dirent ***subsys)
 		       alphasort);
 }
 
-int nvme_scan_subsystem_namespaces(nvme_subsystem_t s, struct dirent ***namespaces)
+int nvme_scan_subsystem_namespaces(nvme_subsystem_t s, struct dirent ***ns)
 {
-	return scandir(nvme_subsystem_get_sysfs_dir(s), namespaces,
+	return scandir(nvme_subsystem_get_sysfs_dir(s), ns,
 		       nvme_namespace_filter, alphasort);
 }
 
@@ -105,14 +105,14 @@ int nvme_scan_ctrls(struct dirent ***ctrls)
 		       alphasort);
 }
 
-int nvme_scan_ctrl_namespace_paths(nvme_ctrl_t c, struct dirent ***namespaces)
+int nvme_scan_ctrl_namespace_paths(nvme_ctrl_t c, struct dirent ***paths)
 {
-	return scandir(nvme_ctrl_get_sysfs_dir(c), namespaces,
+	return scandir(nvme_ctrl_get_sysfs_dir(c), paths,
 		       nvme_paths_filter, alphasort);
 }
 
-int nvme_scan_ctrl_namespaces(nvme_ctrl_t c, struct dirent ***namespaces)
+int nvme_scan_ctrl_namespaces(nvme_ctrl_t c, struct dirent ***ns)
 {
-	return scandir(nvme_ctrl_get_sysfs_dir(c), namespaces,
+	return scandir(nvme_ctrl_get_sysfs_dir(c), ns,
 		       nvme_namespace_filter, alphasort);
 }

src/nvme/filters.h

@@ -19,78 +19,78 @@
  */
 
 /**
- * nvme_namespace_filter() -
- * @d:
+ * nvme_namespace_filter() - Filter for namespaces
+ * @d: dirent to check
  *
- * Return: 
+ * Return: 1 if @d matches, 0 otherwise
  */
 int nvme_namespace_filter(const struct dirent *d);
 
 /**
- * nvme_paths_filter() -
- * @d:
+ * nvme_paths_filter() - Filter for paths
+ * @d: dirent to check
  *
- * Return: 
+ * Return: 1 if @d matches, 0 otherwise
  */
 int nvme_paths_filter(const struct dirent *d);
 
 /**
- * nvme_ctrls_filter() -
- * @d:
+ * nvme_ctrls_filter() - Filter for controllers
+ * @d: dirent to check
  *
- * Return: 
+ * Return: 1 if @d matches, 0 otherwise
  */
 int nvme_ctrls_filter(const struct dirent *d);
 
 /**
- * nvme_subsys_filter() -
- * @d:
+ * nvme_subsys_filter() - Filter for subsystems
+ * @d: dirent to check
  *
- * Return: 
+ * Return: 1 if @d matches, 0 otherwise
  */
 int nvme_subsys_filter(const struct dirent *d);
 
 /**
- * nvme_scan_subsystems() -
- * @subsys:
+ * nvme_scan_subsystems() - Scan for subsystems
+ * @subsys: Pointer to array of dirents
  *
- * Return: 
+ * Return: number of entries in @subsys
  */
 int nvme_scan_subsystems(struct dirent ***subsys);
 
 /**
- * nvme_scan_subsystem_namespaces() -
- * @s:
- * @namespaces:
+ * nvme_scan_subsystem_namespaces() - Scan for namespaces in a subsystem
+ * @s: Subsystem to scan
+ * @n: Pointer to array of dirents
  *
- * Return: 
+ * Return: number of entries in @ns
  */
-int nvme_scan_subsystem_namespaces(nvme_subsystem_t s, struct dirent ***namespaces);
+int nvme_scan_subsystem_namespaces(nvme_subsystem_t s, struct dirent ***ns);
 
 /**
- * nvme_scan_ctrls() -
- * @ctrls:
+ * nvme_scan_ctrls() - Scan for controllers
+ * @ctrls: Pointer to array of dirents
  *
- * Return: 
+ * Return: number of entries in @ctrls
  */
 int nvme_scan_ctrls(struct dirent ***ctrls);
 
 /**
- * nvme_scan_ctrl_namespace_paths() -
- * @c:
- * @namespaces:
+ * nvme_scan_ctrl_namespace_paths() - Scan for namespace paths in a controller
+ * @c: Controller to scan
+ * @paths: Pointer to array of dirents
  *
- * Return: 
+ * Return: number of entries in @paths
  */
-int nvme_scan_ctrl_namespace_paths(nvme_ctrl_t c, struct dirent ***namespaces);
+int nvme_scan_ctrl_namespace_paths(nvme_ctrl_t c, struct dirent ***paths);
 
 /**
- * nvme_scan_ctrl_namespaces() -
- * @c:
- * @namespaces:
+ * nvme_scan_ctrl_namespaces() - Scan for namespaces in a controller
+ * @c: Controller to scan
+ * @ns: Pointer to array of dirents
  *
- * Return: 
+ * Return: number of entries in @ns
  */
-int nvme_scan_ctrl_namespaces(nvme_ctrl_t c, struct dirent ***namespaces);
+int nvme_scan_ctrl_namespaces(nvme_ctrl_t c, struct dirent ***ns);
 
 #endif /* _LIBNVME_FILTERS_H */