koreader-base
koreader-base copied to clipboard
koreader
KOPTContext - add comments explaining Leptonica's usage
Work in progress, the idea is to document what I learned so far, so that others interested in this stuff don't have to rediscover America again ;-). For now I'm adding a cheatsheet, with Leptonica's most common functions we use and short explanation how it's used/what it's used for. Later I'll try to add documentation to a few functions. @poire-z Is something like this acceptable? I'm open to suggestions.
This change is 
Yep! That kind of doc is great! (I would usually be happy to see that around where it's used, but I guess it's used all over the place, so this cheatsheet :)
I know now about PIX, BOX and SEL, but I don't know (yet) which is usually the input and which are the output, etc... A small intro about what k2pdfopt and leptonica are and do (why we need both, how they interoperate...) would be nice too. (Because really, I have no idea :) I guess what k2pdfopt can do for having used the Windows app, but that's it...)
@Frenzie Any advice on how to format this? I can't annotate those functions, since they are part of leptonica and not koptcontext
I'd like to hold it for a while, I'll try to work on this soon. It wraps lines strangely and it just looks bad.
Oh wow, I just realized this is still not merged 😅. I'll work on this on Monday hopefully.
Note to self: make doc is the command.
This looks way better, I'll probably have to move comments above functions, since we are limited to ~80 characters, otherwise ldoc adds vertical scroll.
Maybe both? By the side for the short ones like all the destroys, and above for the ones that'd have to be split across so many lines?
Yup, I think it's good to go, unless someone feels like something needs to be reworded, explained more clearly. I'm open to criticism.
On an unrelated note, I think it's a good idea to block directly pushing to main repos. After this is merged koptcontext-comments branch needs to be deleted ;)
It took me a while to figure out why my commits weren't showing 😅
On an unrelated note, I think it's a good idea to block directly pushing to main repos. After this is merged
koptcontext-commentsbranch needs to be deleted ;)
The master branch is protected from direct pushing to prevent mistakes. Besides that I don't think we're particularly concerned, or at least I don't think it's ever really been an issue. :-)