diff mbox series

[1/2] docs: nvmem: generate kernel-doc API documentation

Message ID 20231201-nvmem-docs-kerneldoc-v1-1-3e8f2b706ce6@bootlin.com
State New
Headers
Series docs: nvmem: minor improvements |

Commit Message

Luca Ceresoli Dec. 1, 2023, 1:10 p.m. UTC 
  This is useful on its own, and it also enables hyperlink generation for
functions mentioned in ReST documentation.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 Documentation/driver-api/nvmem.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Bagas Sanjaya Dec. 3, 2023, 6:04 a.m. UTC | #1 
On Fri, Dec 01, 2023 at 02:10:42PM +0100, Luca Ceresoli wrote:
> This is useful on its own, and it also enables hyperlink generation for
> functions mentioned in ReST documentation.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  Documentation/driver-api/nvmem.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
> index de221e91c8e3..d5655b95c0f4 100644
> --- a/Documentation/driver-api/nvmem.rst
> +++ b/Documentation/driver-api/nvmem.rst
> @@ -200,3 +200,9 @@ and let you add cells dynamically.
>  Another use case for layouts is the post processing of cells. With layouts,
>  it is possible to associate a custom post processing hook to a cell. It
>  even possible to add this hook to cells not created by the layout itself.
> +
> +9. Internal kernel API
> +======================
> +
> +.. kernel-doc:: drivers/nvmem/core.c
> +   :export:
> 

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
diff mbox series

Patch

diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index de221e91c8e3..d5655b95c0f4 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -200,3 +200,9 @@  and let you add cells dynamically.
 Another use case for layouts is the post processing of cells. With layouts,
 it is possible to associate a custom post processing hook to a cell. It
 even possible to add this hook to cells not created by the layout itself.
+
+9. Internal kernel API
+======================
+
+.. kernel-doc:: drivers/nvmem/core.c
+   :export: