string-list.h: move documentation from Documentation/api/ into header
authorHan-Wen Nienhuys <hanwen@google.com>
Tue, 26 Sep 2017 11:21:50 +0000 (13:21 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 27 Sep 2017 00:14:34 +0000 (09:14 +0900)
commit4f665f2cf3374db615bd094269e5dd6eb0811006
tree886ad5dc65284fa2b27ae470c53514d8a29f931a
parent28996cec80690d2322359d3650a57e8de6e01eb6
string-list.h: move documentation from Documentation/api/ into header

This mirrors commit 'bdfdaa497 ("strbuf.h: integrate api-strbuf.txt
documentation, 2015-01-16") which did the same for strbuf.h:

* API documentation uses /** */ to set it apart from other comments.

* Function names were stripped from the comments.

* Ordering of the header was adjusted to follow the one from the text
  file.

* Edited some existing comments from string-list.h for consistency.

Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-string-list.txt [deleted file]
string-list.h