libgdf Re issue #138 - Added some Doxygen comments for the API

Following the discussion on issue 138, here's a hopefully-template-compliant PR adding documentation to some API functions and data types (not all of them).

There are other some minor tweaks such as removal of some /* ---- */s, spelling and rephrasing.

Oct 22 '18 11:10 eyalroz

Can one of the admins verify this patch?

Oct 22 '18 18:10 GPUtester

@GPUtester : If somebody started to do that, they need to restart, since I just amended the commit myself after finding some typos.

Oct 22 '18 18:10 eyalroz

Is this coordinated with prior work being done here? https://github.com/rapidsai/libgdf/pull/156

Oct 23 '18 02:10 jrhemstad

Is this coordinated with prior work being done here? #156

Not as such, no. As a relative newcomer to BlazingDB, I wanted to clear things up for myself about the API - now that I'm going to use it or add to it. I picked @felipeblazing 's brain about some of the API, and read the sources for other parts of it, and this was the result.

Oct 23 '18 06:10 eyalroz

@jrhemstad : I've replaced the ///s with ///<s.

Oct 23 '18 06:10 eyalroz