Add brief docs for exported classes
ClosedPublic

Authored by piggz on Dec 18 2017, 8:54 PM.

Details

Summary

Doc changes only

Test Plan

No code changes

Diff Detail

Repository
R14 KReport
Branch
doc31
Lint
No Linters Available
Unit
No Unit Test Coverage
piggz created this revision.Dec 18 2017, 8:54 PM
Restricted Application added a project: KReport. · View Herald TranscriptDec 18 2017, 8:54 PM
piggz requested review of this revision.Dec 18 2017, 8:54 PM
staniek requested changes to this revision.Dec 18 2017, 9:39 PM

Good, minor ones left.

src/common/KReportDataSource.h
28

Case

src/common/KReportUnit.h
60

% not needed here.

src/renderer/KReportRendererBase.h
59

I think after @brief we may need blank line or else all sentences get into the brief unless another command such as @todo or @note or @para is used.

src/renderer/scripting/KReportScriptHandler.h
45

+empty line

src/renderer/scripting/KReportScriptSource.h
28

+empty line

src/wrtembed/KReportDesignerSection.h
42

+empty line

This revision now requires changes to proceed.Dec 18 2017, 9:39 PM
piggz updated this revision to Diff 24086.Dec 18 2017, 9:48 PM
  • addres comments
staniek accepted this revision.Dec 18 2017, 11:55 PM
This revision is now accepted and ready to land.Dec 18 2017, 11:55 PM
This revision was automatically updated to reflect the committed changes.