Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1236456

[PATCH] staging: comedi: comedi_pci.c: Fix kernel-doc Return tags

Show all headers | View raw

Fix the 'Return' tags in the kernel-doc comments as they currently say
'Returns', which is not recognized by kernel-doc.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
---
 drivers/staging/comedi/comedi_pci.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/staging/comedi/comedi_pci.c b/drivers/staging/comedi/comedi_pci.c
index 0601049..51e023a 100644
--- a/drivers/staging/comedi/comedi_pci.c
+++ b/drivers/staging/comedi/comedi_pci.c
@@ -28,8 +28,8 @@
  * Assuming @dev->hw_dev is non-%NULL, it is assumed to be pointing to a
  * a &struct device embedded in a &struct pci_dev.
  *
- * Returns: Attached PCI device if @dev->hw_dev is non-%NULL.
- * Returns %NULL if @dev->hw_dev is %NULL.
+ * Return: Attached PCI device if @dev->hw_dev is non-%NULL.
+ * Return %NULL if @dev->hw_dev is %NULL.
  */
 struct pci_dev *comedi_to_pci_dev(struct comedi_device *dev)
 {
@@ -48,7 +48,7 @@ EXPORT_SYMBOL_GPL(comedi_to_pci_dev);
  *
  * Calls to comedi_pci_enable() and comedi_pci_disable() cannot be nested.
  *
- * Returns:
+ * Return:
  *	0 on success,
  *	-%ENODEV if @dev->hw_dev is %NULL,
  *	-%EBUSY if regions busy,
@@ -143,7 +143,7 @@ EXPORT_SYMBOL_GPL(comedi_pci_detach);
  * "auto_attach" handler.  The "auto_attach" handler may call
  * comedi_to_pci_dev() on the passed in COMEDI device to recover @pcidev.
  *
- * Returns: The result of calling comedi_auto_config() (0 on success, or
+ * Return: The result of calling comedi_auto_config() (0 on success, or
  * a negative error number on failure).
  */
 int comedi_pci_auto_config(struct pci_dev *pcidev,
@@ -183,7 +183,7 @@ EXPORT_SYMBOL_GPL(comedi_pci_auto_unconfig);
  * to register the COMEDI driver and the PCI driver.  Do not call it directly,
  * use the module_comedi_pci_driver() helper macro instead.
  *
- * Returns: 0 on success, or a negative error number on failure.
+ * Return: 0 on success, or a negative error number on failure.
  */
 int comedi_pci_driver_register(struct comedi_driver *comedi_driver,
 			       struct pci_driver *pci_driver)
-- 
2.5.3

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH] staging: comedi: comedi_pci.c: Fix kernel-doc Return tags Ian Abbott <abbotti@mev.co.uk> - 2015-09-30 17:50 +0200
  RE: [PATCH] staging: comedi: comedi_pci.c: Fix kernel-doc Return tags Hartley Sweeten <HartleyS@visionengravers.com> - 2015-09-30 20:40 +0200

csiph-web