development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-07-17 02:57:48 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Merge branch 'jc/how-to-document-api'

Browse source 
Doc update.

* jc/how-to-document-api:
  CodingGuidelines: document the API in *.h files
This commit is contained in:
Junio C Hamano 2018-10-19 13:34:05 +09:00
parent d152a74e25 d9f079ad1a
commit 0d4f473a98
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Documentation/CodingGuidelines
View file

@ -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