D21271: [WIP] Improve documentation of TextEntity stuff

[David Hurka]

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

REVISION SUMMARY
  This adds some important documentation on TextEntity and other classes, and improves some of the existing documentation.
  
  This includes changing parameter names from ‘rect’ to ‘area’, because I found ‘rect’ misleading.

TEST PLAN
  Run doxygen

REPOSITORY
  R223 Okular

BRANCH
  improve-documentation-of-textentity-handling

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

AFFECTED FILES
  core/page.cpp
  core/textpage.cpp
  core/textpage.h
  core/textpage_p.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/20190518/30f8f78e/attachment.html>