D21266: [WIP] Improve documentation of area classes

[David Hurka]

davidhurka created this revision.
davidhurka added a reviewer: Okular.
Herald added a project: Okular.
Herald added a subscriber: okular-devel.
davidhurka requested review of this revision.

REVISION 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.
  
  Also found some potential bugs in functions which are currently unused.
  
  Todo:
  There are these ObjectRect classes, and I don’t know what makes them
  better than NormalizedRect in their current applications.
  
  Also see my (inline) comments.

TEST PLAN
  Run doxygen

REPOSITORY
  R223 Okular

BRANCH
  improve-area-classes-documentation-phabricator

REVISION DETAIL
  https://phabricator.kde.org/D21266

AFFECTED FILES
  core/area.h

To: davidhurka, #okular
Cc: okular-devel, joaonetto, tfella, ngraham, darcyshen, aacid
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/okular-devel/attachments/20190517/daae946a/attachment.html>