Fix minor Doxygen issues
ClosedPublic
Actions

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

Details

Reviewers

thomasfischer

Group Reviewers

KBibTeX

Commits

R462:4a80eca6e5f8: Fix minor Doxygen issues

Summary

Fix some linking and "undocumented" issues.

Test Plan

Create doxygen PDF, new links work as expected

Repository

R462 KBibTeX

Branch

master

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 20476
Build 20494: arc lint + arc unit

yurchor requested review of this revision.Dec 31 2019, 6:00 PM

yurchor created this revision.

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
112	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

Should be fixed now. Thanks.

Fix the issues found

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.

			Path	Packages
M			src/data/entry.h (5 lines)
M			src/data/file.h (6 lines)
M			src/io/fileimporterbibtex.h (7 lines)
M			src/networking/onlinesearch/onlinesearchabstract.h (1 line)
M			src/parts/part.cpp (2 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	72499	16d96d4		Dec 31 2019, 6:00 PM	★	★
Diff 2	72520	16d96d4	Fix the issues found	Jan 1 2020, 11:52 AM	★	★
Diff 3	72797	e964ce0	R462:4a80eca6e5f848cf6a4fcd1e0381f43ea832cf2f	Jan 5 2020, 2:38 PM	★	★