[poppler] Patch: Some documentation
Albert Astals Cid
aacid at kde.org
Mon Jul 16 13:26:52 PDT 2012
El Dilluns, 16 de juliol de 2012, a les 19:48:05, vau escriure:
> On 7/15/12, Albert Astals Cid <aacid at kde.org> wrote:
> > El Dimarts, 10 de juliol de 2012, a les 16:42:47, cheshirekow va escriure:
> >> As I've been trying to learn the API I've been adding doxygen style
> >> comments my own git branch. I'm not sure if all my comments are correct
> >> but it has helped me keep track of what I've figured out thus far, and
> >> perhaps may be useful to others.
> > i know it is doxygen syntax, but to be honest we do *not*
> > want people to use poppler core internals, so documentation of functions
> > should be for internal consumption only thus the need for doxygen-like
> > syntax is small in my opinion.
> What about people who want to fix and contribute the fixes/etc to the
> said internals?
That's fine, but do you need
- // Retuns the entry that belongs to the offset
+ /// Returns the entry that belongs to the offset
> > What do others think?
> More documentation is better. Anything that helps understanding what
> the hell is going on inside, is good.
Sure, but you're not answering my question ;-)
More information about the poppler