Fix minor Doxygen issues
ClosedPublic

Authored by yurchor on Dec 31 2019, 6:00 PM.

Details

Summary

Fix some linking and "undocumented" issues.

http://ebn.kde.org/apidocs/apidox-extragear/office-kbibtex.html

Test Plan

Create doxygen PDF, new links work as expected

Diff Detail

Repository
R462 KBibTeX
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
yurchor requested review of this revision.Dec 31 2019, 6:00 PM
yurchor created this revision.
thomasfischer requested changes to this revision.Jan 1 2020, 11:42 AM

Thanks for the input. I have a few comments to make the "param" texts more descriptive.

src/data/file.h
76

Is it convention for KDE ApiDox documentation to use tt formatting here? Also, the documentation should be updated to nullptr instead of NULL.

src/io/fileimporterbibtex.h
85

More descriptive: "Line number to use in error message if splitting failed"

97

Same issue as above with line_number

src/networking/onlinesearch/onlinesearchabstract.h
107

Can you please write a little bit more information about this variable. Just that it is a "network reply" is obvious from being of class QNetworkReply. For example, this is thereply the function will handle errors for.

This revision now requires changes to proceed.Jan 1 2020, 11:42 AM
yurchor marked 4 inline comments as done.Jan 1 2020, 11:51 AM

Should be fixed now. Thanks.

yurchor updated this revision to Diff 72520.Jan 1 2020, 11:52 AM

Fix the issues found

thomasfischer accepted this revision.Jan 5 2020, 2:12 PM

Well done. Ship it!

This revision is now accepted and ready to land.Jan 5 2020, 2:12 PM
This revision was automatically updated to reflect the committed changes.