diff options
author | Anthony DiGirolamo <tonymd@google.com> | 2023-02-23 18:00:15 +0000 |
---|---|---|
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-02-23 18:00:15 +0000 |
commit | 8788fb08e2595a4e9c9606997887897f18f45bea (patch) | |
tree | fd655a8cd85bf3b2aa82d958a92576cc71202012 /pw_presubmit | |
parent | 132e1b499dbd28aec0e9b16211f16ccd26fa8e12 (diff) | |
download | pigweed-8788fb08e2595a4e9c9606997887897f18f45bea.tar.gz |
docs: Support Doxygen style comment blocks
- Include doxygen cipd package
- Add breathe to Python packages and configure for Sphinx
- run_doxygen.py and pw_python_action in //docs/BUILD.gn
- //docs/Doxyfile
- Style guide now has a code block section
- Convert pw_chrono + pw_sync to use all doxygen directives instead
of cpp:* directives. Also resolved doc content conflicts between
the .rst and .h files.
Change-Id: Ic3056bad257e140e0f2a5037473a14fe98103168
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/99860
Reviewed-by: Kayce Basques <kayce@google.com>
Commit-Queue: Anthony DiGirolamo <tonymd@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Diffstat (limited to 'pw_presubmit')
-rwxr-xr-x | pw_presubmit/py/pw_presubmit/pigweed_presubmit.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py b/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py index 2f9a6a0f8..843517dc6 100755 --- a/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py +++ b/pw_presubmit/py/pw_presubmit/pigweed_presubmit.py @@ -562,6 +562,7 @@ def edit_compile_commands( _EXCLUDE_FROM_COPYRIGHT_NOTICE: Sequence[str] = ( # Configuration # keep-sorted: start + r'\bDoxyfile$', r'\bPW_PLUGINS$', r'\bconstraint.list$', r'^(?:.+/)?\..+$', |