Bug 242903 - [GTK][WPE] Some entities are missing brief descriptions, or are too long
Summary: [GTK][WPE] Some entities are missing brief descriptions, or are too long
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: WebKit Local Build
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: lisiwei
URL:
Keywords: InRadar
Depends on:
Blocks:
 
Reported: 2022-07-19 08:41 PDT by Adrian Perez
Modified: 2022-08-04 01:07 PDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Adrian Perez 2022-07-19 08:41:18 PDT
When using gi-docgen (after bug #239016), it will use the first paragraph
of a documentation comment as the “brief” description an entity (function,
struct, etc.). Many are already fine, but gtk-doc (which we used before)
did not work in the same way, which means a number of documentation comments
are missing a brief description, or the existing one is too long and usually
should be taken as long description instead.

It would be good to find the items with missing brief descriptions and add
them. One idea to avoid reading all the documentation comments manually
would be to make a script that parses the .gir XML used as input for gi-docgen
which detects items with only one paragraph, or more than one paragraph but
the first one is too long (more than 80-90 characters, or a similar check.)
Comment 1 lisiwei 2022-07-30 22:16:52 PDT
Pull request: https://github.com/WebKit/WebKit/pull/2880
Comment 2 EWS 2022-08-04 01:06:20 PDT
Committed 253104@main (39f864825530): <https://commits.webkit.org/253104@main>

Reviewed commits have been landed. Closing PR #2880 and removing active labels.
Comment 3 Radar WebKit Bug Importer 2022-08-04 01:07:16 PDT
<rdar://problem/98108319>