devicetree: clocks: fix a docstring

mbolivar-nordic · MaureenHelm · commit f86f6e002510 · 2022-02-03T14:19:16.000-06:00
Fix the formatting and what looks like a copy/paste error
in the DT_CLOCKS_CTLR_BY_NAME doxygen docstring.

Signed-off-by: Martí Bolívar &lt;marti.bolivar@nordicsemi.no&gt;
diff --git a/include/devicetree/clocks.h b/include/devicetree/clocks.h
@@ -61,9 +61,8 @@ extern "C" {
 
 /**
  * @brief Get the node identifier for the controller phandle from a
- *        clocks phandle-array property at an index
+ *        clocks phandle-array property by name
  *
-
  * Example devicetree fragment:
  *
  *     clk1: clock-controller@... { ... };

Original file line number	Diff line number	Diff line change
`@@ -61,9 +61,8 @@ extern "C" {`
`61`	`61`
`62`	`62`	`/**`
`63`	`63`	`* @brief Get the node identifier for the controller phandle from a`
`64`		`- * clocks phandle-array property at an index`
	`64`	`+ * clocks phandle-array property by name`
`65`	`65`	`*`
`66`		`-`
`67`	`66`	`* Example devicetree fragment:`
`68`	`67`	`*`
`69`	`68`	`* clk1: clock-controller@... { ... };`