decorate: clean up and document API

Improve the names of the identifiers in decorate.h, document them, and
add an example of how to use these functions.

The example is compiled and run as part of the test suite.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jonathan Tan
2017-12-07 16:14:24 -08:00
committed by Junio C Hamano
parent 95ec6b1b33
commit ddd3e31242
8 changed files with 146 additions and 25 deletions

View File

@ -1,6 +0,0 @@
decorate API
============
Talk about <decorate.h>
(Linus)