diff options
author | Patrick Delaunay <patrick.delaunay@foss.st.com> | 2022-01-12 10:53:49 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-15 10:57:21 +0100 |
commit | be74f71a679c8ca25a09bea86967dcee8a8b8cae (patch) | |
tree | 9e68ea793684a86be2de38a649d5f812642f9f52 /include/dm/of.h | |
parent | 6de6a615f8527b722b512b0ea36821ab2439b773 (diff) |
doc: add include/dm/of*.h to the HTML documentation
Correct Sphinx style comments in include/dm/ofnode.h
and add the device tree node API to the HTML documentation;
the ofnode functions are compatible with Live tree or with flat
device tree.
Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'include/dm/of.h')
-rw-r--r-- | include/dm/of.h | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/include/dm/of.h b/include/dm/of.h index 5cb6f44a6c6..9c9065b7932 100644 --- a/include/dm/of.h +++ b/include/dm/of.h @@ -58,14 +58,13 @@ struct device_node { * struct of_phandle_args - structure to hold phandle and arguments * * This is used when decoding a phandle in a device tree property. Typically - * these look like this: + * these look like this:: * - * wibble { - * phandle = <5>; - * }; - * - * ... - * some-prop = <&wibble 1 2 3> + * wibble { + * phandle = <5>; + * }; + * ... + * some-prop = <&wibble 1 2 3> * * Here &node is the phandle of the node 'wibble', i.e. 5. There are three * arguments: 1, 2, 3. |