D21271: [WIP] Improve documentation of TextEntity stuff

[David Hurka]

davidhurka marked 4 inline comments as done.
davidhurka added inline comments.

INLINE COMMENTS

> aacid wrote in textpage.cpp:1880
> pagesSizeMetric defines what pagesize means for your generator.

Ok, if it is documented directly in Generator, it should be sufficient. Maybe I was looking at PageSize only.

> aacid wrote in textpage_p.h:32
> Why are there new functions in an "improve documentation" merge request?

As mentioned somewhere else, the algorithms in these functions are interesting. (Besides they don’t do a good job with vertical text. I hope by writing documentation I will get some understanding what changes could be appropiate.)

I just didn’t write the documentation yet (Blahblah placeholders), but doxygen won’t compile it if they don’t appear in this header file. Maybe there is some other way to compile it, just tell me which way is better.

I think that these functions should be private members of TextPagePrivate, because that is where they are used. If I understand PIMPL correctly, that would be no problem for binary compability.

REPOSITORY
  R223 Okular

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

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