Verified
Status Update
No update yet.
Comments
ap...@google.com
Project: pigweed/pigweed
Branch: main
commit b8c57389bb2e637117b0f25359c04b7a675a332a
Author: Kayce Basques <kayce@google.com>
Date: Tue Aug 01 00:19:57 2023
pw_analog: Include header files as stopgap API reference
The pw_analog doc doesn't have an API reference section. This change
provides stopgap API reference content by injecting the module's
header files into the module's doc.
Bug:
Change-Id: I16f61cce9d41c47f60a48071f7ba1f77c043c7d8
Reviewed-on:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/161491
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
Reviewed-by: Kevin Zeng <zengk@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Reviewed-by: Kayce Basques <kayce@google.com>
M pw_analog/BUILD.gn
M pw_analog/docs.rst
https://pigweed-review.git.corp.google.com/161491
Branch: main
commit b8c57389bb2e637117b0f25359c04b7a675a332a
Author: Kayce Basques <kayce@google.com>
Date: Tue Aug 01 00:19:57 2023
pw_analog: Include header files as stopgap API reference
The pw_analog doc doesn't have an API reference section. This change
provides stopgap API reference content by injecting the module's
header files into the module's doc.
Bug:
Change-Id: I16f61cce9d41c47f60a48071f7ba1f77c043c7d8
Reviewed-on:
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
Reviewed-by: Kevin Zeng <zengk@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Reviewed-by: Kayce Basques <kayce@google.com>
M pw_analog/BUILD.gn
M pw_analog/docs.rst
ka...@google.com
I will keep pointing changes to this bug if/when we use this approach in the future but there's no reason to keep this bug open
Description
Lots of Pigweed modules are missing API reference documentation. Many of these modules have well-commented C++ headers. In the long run, we will generate the API references from Doxygen. In the short run, we can use Sphinx's