docs: interconnect: Improve API documentation coverage

[PATCH 0/2] docs: interconnect: Improve API documentation coverage

Posted by Kuan-Wei Chiu 3 weeks, 4 days ago

Improve the generic interconnect subsystem documentation by including
the existing kernel-doc comments from the source files.

Currently, the documentation only includes the provider data structures
from the header file and incorrectly states that consumer APIs are
undocumented.

Since drivers/interconnect/core.c contains a mix of both provider and
consumer APIs, this series uses the kernel-doc :functions: directive to
properly separate and document them in their respective sections.

Kuan-Wei Chiu (2):
  docs: interconnect: Add provider APIs to documentation
  docs: interconnect: Document consumer APIs and drop outdated text

 Documentation/driver-api/interconnect.rst | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

-- 
2.53.0.851.ga537e3e6e9-goog

Re: [PATCH 0/2] docs: interconnect: Improve API documentation coverage

Posted by Jonathan Corbet 2 weeks, 6 days ago

Kuan-Wei Chiu <visitorckw@gmail.com> writes:

> Improve the generic interconnect subsystem documentation by including
> the existing kernel-doc comments from the source files.
>
> Currently, the documentation only includes the provider data structures
> from the header file and incorrectly states that consumer APIs are
> undocumented.
>
> Since drivers/interconnect/core.c contains a mix of both provider and
> consumer APIs, this series uses the kernel-doc :functions: directive to
> properly separate and document them in their respective sections.
>
> Kuan-Wei Chiu (2):
>   docs: interconnect: Add provider APIs to documentation
>   docs: interconnect: Document consumer APIs and drop outdated text
>
>  Documentation/driver-api/interconnect.rst | 16 ++++++++++++++--
>  1 file changed, 14 insertions(+), 2 deletions(-)

Series applied, thanks.

jon