WebKit Bugzilla
New
Browse
Search+
Log In
×
Sign in with GitHub
or
Remember my login
Create Account
·
Forgot Password
Forgotten password account recovery
RESOLVED FIXED
242903
[GTK][WPE] Some entities are missing brief descriptions, or are too long
https://bugs.webkit.org/show_bug.cgi?id=242903
Summary
[GTK][WPE] Some entities are missing brief descriptions, or are too long
Adrian Perez
Reported
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.)
Attachments
Add attachment
proposed patch, testcase, etc.
lisiwei
Comment 1
2022-07-30 22:16:52 PDT
Pull request:
https://github.com/WebKit/WebKit/pull/2880
EWS
Comment 2
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.
Radar WebKit Bug Importer
Comment 3
2022-08-04 01:07:16 PDT
<
rdar://problem/98108319
>
Note
You need to
log in
before you can comment on or make changes to this bug.
Top of Page
Format For Printing
XML
Clone This Bug