diff options
| author | Junio C Hamano <gitster@pobox.com> | 2018-10-19 07:34:05 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-10-19 07:34:05 +0300 |
| commit | 0d4f473a985e5b5f15ae88fd8dda695a694b9955 (patch) | |
| tree | adafde44c1aff202ef8d153378112ff74690ffdb | |
| parent | d152a74e2584dd0e235c9bcc97ef6a9ed239994a (diff) | |
| parent | d9f079ad1a866151fea01f7f977dfbd1ba4d97f7 (diff) | |
Merge branch 'jc/how-to-document-api'
Doc update.
* jc/how-to-document-api:
CodingGuidelines: document the API in *.h files
| -rw-r--r-- | Documentation/CodingGuidelines | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 72967deb78..8579530710 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -376,7 +376,10 @@ For C programs: string_list for sorted string lists, a hash map (mapping struct objects) named "struct decorate", amongst other things. - - When you come up with an API, document it. + - When you come up with an API, document its functions and structures + in the header file that exposes the API to its callers. Use what is + in "strbuf.h" as a model for the appropriate tone and level of + detail. - The first #include in C files, except in platform specific compat/ implementations, must be either "git-compat-util.h", "cache.h" or |