D21266: [WIP] Improve documentation of area classes

[David Hurka]

davidhurka marked 12 inline comments as done.
davidhurka added a comment.


  Thanks for marking the typos.
  
  I tried to use your latest comments for improvements, without changing much else. (In the end I changed only 3 sentences.)

INLINE COMMENTS

> aacid wrote in area.h:214
> what if they want it to be negative for some reason? Does anything break? i mean the lines above clearly say left, top, and bottom.

Yes, e. g. if `left` is right of `right`, the geometry operations (|=, &=, etc) don’t behave really ...obviously defined. It will probably work, but it might work differently as soon as someone tries to fix a bug.

The problem is mainly that the behaviour will not be defined even after //this// patch, so I simply write it this way.

> aacid wrote in area.h:128
> i still don't like the "is used" wording, it's like binds it forever, if you really want to reference a class (can't people use grep or find all in an IDE), i'd prefer a wording like "for example is used in" or similar

is used -> can be used e. g.

Better?

REPOSITORY
  R223 Okular

BRANCH
  improve-area-classes-documentation

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

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