EDAC: Fix some kernel-doc markups

Kernel-doc markup should use this format:
        identifier - description

Correct that and also fix some enums' names in the kernel-doc markup.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Borislav Petkov <bp@suse.de>
Link: https://lkml.kernel.org/r/1d291393ba58c7b80908a3fedf02d2f53921ffe9.1603469755.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab 2020-10-23 18:32:57 +02:00 committed by Borislav Petkov
parent f30795fb40
commit 2426999902
2 changed files with 7 additions and 8 deletions

View File

@ -258,7 +258,7 @@ extern struct edac_device_ctl_info *edac_device_alloc_ctl_info(
extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info); extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);
/** /**
* edac_device_add_device: Insert the 'edac_dev' structure into the * edac_device_add_device - Insert the 'edac_dev' structure into the
* edac_device global list and create sysfs entries associated with * edac_device global list and create sysfs entries associated with
* edac_device structure. * edac_device structure.
* *
@ -271,9 +271,8 @@ extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);
extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev); extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev);
/** /**
* edac_device_del_device: * edac_device_del_device - Remove sysfs entries for specified edac_device
* Remove sysfs entries for specified edac_device structure and * structure and then remove edac_device structure from global list
* then remove edac_device structure from global list
* *
* @dev: * @dev:
* Pointer to struct &device representing the edac device * Pointer to struct &device representing the edac device
@ -286,7 +285,7 @@ extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev);
extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev); extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev);
/** /**
* Log correctable errors. * edac_device_handle_ce_count - Log correctable errors.
* *
* @edac_dev: pointer to struct &edac_device_ctl_info * @edac_dev: pointer to struct &edac_device_ctl_info
* @inst_nr: number of the instance where the CE error happened * @inst_nr: number of the instance where the CE error happened
@ -299,7 +298,7 @@ void edac_device_handle_ce_count(struct edac_device_ctl_info *edac_dev,
const char *msg); const char *msg);
/** /**
* Log uncorrectable errors. * edac_device_handle_ue_count - Log uncorrectable errors.
* *
* @edac_dev: pointer to struct &edac_device_ctl_info * @edac_dev: pointer to struct &edac_device_ctl_info
* @inst_nr: number of the instance where the CE error happened * @inst_nr: number of the instance where the CE error happened

View File

@ -229,7 +229,7 @@ enum mem_type {
#define MEM_FLAG_NVDIMM BIT(MEM_NVDIMM) #define MEM_FLAG_NVDIMM BIT(MEM_NVDIMM)
/** /**
* enum edac-type - Error Detection and Correction capabilities and mode * enum edac_type - Error Detection and Correction capabilities and mode
* @EDAC_UNKNOWN: Unknown if ECC is available * @EDAC_UNKNOWN: Unknown if ECC is available
* @EDAC_NONE: Doesn't support ECC * @EDAC_NONE: Doesn't support ECC
* @EDAC_RESERVED: Reserved ECC type * @EDAC_RESERVED: Reserved ECC type
@ -309,7 +309,7 @@ enum scrub_type {
#define OP_OFFLINE 0x300 #define OP_OFFLINE 0x300
/** /**
* enum edac_mc_layer - memory controller hierarchy layer * enum edac_mc_layer_type - memory controller hierarchy layer
* *
* @EDAC_MC_LAYER_BRANCH: memory layer is named "branch" * @EDAC_MC_LAYER_BRANCH: memory layer is named "branch"
* @EDAC_MC_LAYER_CHANNEL: memory layer is named "channel" * @EDAC_MC_LAYER_CHANNEL: memory layer is named "channel"