D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka marked 2 inline comments as done. REPOSITORY R223 Okular BRANCH improve-documentation-of-textentity-stuff REVISION DETAIL https://phabricator.kde.org/D21271 To: davidhurka, #okular, aacid Cc: aacid, yurchor, okular-devel, fbampaloukas, joaonetto, tfella, ngraham, darcyshen

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka marked 11 inline comments as done. davidhurka added a comment. In D21271#485445 , @aacid wrote: > You don't have a committer account, right? No. INLINE COMMENTS > aacid wrote in textpage.h:168 > concatenate = to put things tog

D21271: [WIP] Improve documentation of TextEntity stuff

aacid accepted this revision. aacid added a comment. This revision is now accepted and ready to land. Thanks for putting up with me. You don't have a committer account, right? INLINE COMMENTS > davidhurka wrote in textpage.h:168 > How do you get from concatenate to append? > > I’m not t

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka added inline comments. INLINE COMMENTS > aacid wrote in textpage.h:53 > 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 clas

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka updated this revision to Diff 60383. davidhurka marked 10 inline comments as done. davidhurka added a comment. - Remove comment on vertical text, remove the word concatenate - Don’t export text entity reordering functions REPOSITORY R223 Okular CHANGES SINCE LAST UPDATE https

D21271: [WIP] Improve documentation of TextEntity stuff

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 c

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka marked an inline comment as done. davidhurka added inline comments. INLINE COMMENTS > aacid wrote in textpage_p.h:32 > Ah, you're trying to export already existing functions :D > > Didn't realize that. > > Why do you want to export them? Yes their are interesting, but where would >

D21271: [WIP] Improve documentation of TextEntity stuff

aacid added inline comments. INLINE COMMENTS > davidhurka wrote in textpage_p.h:32 > 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 chang

D21271: [WIP] Improve documentation of TextEntity stuff

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 Page

D21271: [WIP] Improve documentation of TextEntity stuff

aacid added inline comments. INLINE COMMENTS > davidhurka wrote in textpage.cpp:1880 > Looks like I messed up my comments. > > > This is some interesting information, which should be documented more > > visible. Is the information still true? > > belongs only to line 1880: > > // m_page->wi

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka added inline comments. INLINE COMMENTS > aacid wrote in textpage.cpp:1880 > Why should it documented more visible? Who else cares? Looks like I messed up my comments. > This is some interesting information, which should be documented more > visible. Is the information still true? b

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka updated this revision to Diff 58322. davidhurka marked 2 inline comments as done. davidhurka added a comment. - Fix typos spotted by yurchor - Fix typos spotted by Albert REPOSITORY R223 Okular CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D21271?vs=58251&id=58322 BR

D21271: [WIP] Improve documentation of TextEntity stuff

aacid added inline comments. INLINE COMMENTS > davidhurka wrote in textpage.cpp:1880 > This is some interesting information, which should be documented more > visible. Is the information still true? Why should it documented more visible? Who else cares? > textpage.h:39 > * > - * Also some do

D21271: [WIP] Improve documentation of TextEntity stuff

davidhurka added a comment. TextPagePrivate::correctTextOrder() calls some complex functions, which are yet undocumented. Interesting stuff is happening in them, so they should get some documentation. I added their prototypes to core/textpage_p.h, so I can add documentation to them. In

D21271: [WIP] Improve documentation of TextEntity stuff

yurchor added a comment. Thanks for fixing these typos. INLINE COMMENTS > textpage.h:179 > /** > - * Text extraction function. > + * Text extraction function. Looks for text in the given @param > area, and concatenates it to a string. > * Should be "@p are

D21271: [WIP] Improve documentation of TextEntity stuff

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