eina: Cleanup documentation for Sparse Matrix.
authorBryce Harrington <bryce@osg.samsung.com>
Mon, 16 Apr 2018 18:20:21 +0000 (11:20 -0700)
committerWonki Kim <wonki_.kim@samsung.com>
Tue, 29 May 2018 04:06:50 +0000 (13:06 +0900)
commitfbccf200011dc1815825ab2172880d625c81b863
treea0d2244d1ad5d0966123b037c30df2f58eb56af2
parenteb2aad3d76edf51737fbe3ca3f0a18e999b6ba5a
eina: Cleanup documentation for Sparse Matrix.

Summary:
Revises some descriptions, polishes wording, makes punctuation and
formatting more consistent, and straightens out some convoluted grammar
here and there.

There are a few places where the parameter documentation was incorrectly
cut-and-pasted from other routines, so this is fixed.  Also, in
eina_matrixsparse_iterator_new() the docs say the elements are not
returned sequentially, but from the context and code I think it meant to
say they're not _consecutive_.

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D5924

Reviewed-by: Cedric BAIL <cedric@osg.samsung.com>
src/lib/eina/eina_matrixsparse.h