summaryrefslogtreecommitdiff
path: root/Documentation/coding-style.rst
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-08-10 00:39:05 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-08-16 00:50:53 +0300
commitce690bd9d7abeab6e7f69b83d0ad4d6fac47aa25 (patch)
treeca4f4a21a27c1202fd39dbd38b3b7bd0089d01e3 /Documentation/coding-style.rst
parent39f01e9185857a872e2ae4617d8ea1bb341539f8 (diff)
libcamera: controls: Improve formatting of control descriptions in YAML
The control descriptions from YAML files are extracted to generate Doxygen documentation blocks for the controls, which are then compiled to HTML. The extraction script uses the first line of the description as the Doxygen \brief, and preserves blank lines to keep paragraphs. The control descriptions in the YAML files have however not all been written with this in mind. Many description elements are not formatted as block string scalars, in the first place, so blank lines are lost when parsing YAML. Furthermore, they often start with a long initial paragraph, making the \brief description very long. Improve the documentation formatting by marking all multiline descriptions as block string scalars, and try to provide a short one-line first paragraph to be used as a \brief. While at it, reflow the documentation to the 80 columns limit. The draft controls are left as-is, as they should evolve to non-draft controls eventually (and ideally sooner than later). Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Milan Zamazal <mzamazal@redhat.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'Documentation/coding-style.rst')
0 files changed, 0 insertions, 0 deletions