Move documentation from sds.c to sds.h

antirez / sds

Simple Dynamic Strings library for C

BSD 2-Clause "Simplified" License

4.93k stars 480 forks source link

Move documentation from sds.c to sds.h #88

Closed vonnieda closed 6 years ago

vonnieda commented 6 years ago

This PR moves the function documentation from sds.c to sds.h. This makes the documentation more readily available to non-source and library users, and makes it easier for an IDE to find when doing code completion.

I chose to move it rather than copy it so that the copies would not become out of sync over time.

There are no changes to functionality, only to comments.

vonnieda commented 6 years ago

Apologies - I accidentally committed an internal change to the PR on https://github.com/antirez/sds/pull/88/commits/e8c9d51d6afe18b2453e7c9d2de6960bfe5732ff. Will resubmit on it's own branch.