D21271: [WIP] Improve documentation of TextEntity stuff

[Albert Astals Cid]

aacid added inline comments.

INLINE COMMENTS

> textpage.h:53
> + * @par Vertical Text
> + * Currently, the reordering mixes up TextEntitys which represent glyphs or words of vertical text.
> + * If searching for or highlighting of vertical text is important for the document type,

I'm not convinced we should mention this (and even less in this class), sure it's a bug, but hopefully it'll be fixed and when it does noone will remember to remove this since the bug is not even in this class.

> davidhurka wrote in textpage.h:168
> Agreed, will remove that sentence.
> 
> This is related to textArea( TextSelction * ), I will mention that instead.

concatenate is not the word you want here.

Concactenate means "apppend" and there's no string passed in to get it appended to.

"returns it as a string", which as pointed out is already below, but if you really want that sentence to exist please use return as not concatenate it to

> davidhurka wrote in textpage_p.h:32
> I have exported them to find them in this header file later. But I prefer to do the opposite by moving them to TextPagePrivate.
> 
> Anyway, they could, //maybe//, be useful for an OCR application which uses Okularpart to show input and result. Not planning to do that.

You're trying to do to different things here then, this says "improve documentation" so please don't move code around, let's try to focus on the documentation :)

REPOSITORY
  R223 Okular

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

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