Improve documentation of area classes

Authored by davidhurka on Jul 21 2019, 5:59 PM.

Description

Improve documentation of area classes

Summary:
This shall improve the documentation of several area classes,
including NormalizedPoint, NormalizedRect, RegularArea, RegularAreaRect.

This shall also clarify when absolute coordinates and when normalized
coordinates are used.

Describes the normalized coordinate system in NormalizedPoint, with a new term “reference area” do describe mapping.

TODO:
Page view rotation.
This is not done consistently in Okular, but can be changed later. I think this documentation will help (me) with that then.

Test Plan: Run doxygen

Reviewers: Okular, aacid

Reviewed By: Okular, aacid

Subscribers: aacid, okular-devel

Tags: Okular

Differential Revision: https://phabricator.kde.org/D21266

Details

Committed
aacidJul 21 2019, 6:00 PM
Reviewer
Okular
Differential Revision
D21266: Improve documentation of area classes
Parents
R223:c61a9587ec00: Improve documentation of TextEntity stuff
Branches
Unknown
Tags
Unknown