Auto-generate some documentation

This commit is contained in:
Justine Tunney 2020-12-26 02:09:07 -08:00
parent 117d0111ab
commit 13437dd19b
97 changed files with 2033 additions and 661 deletions

View file

@ -28,17 +28,17 @@
*
* For example, strictly:
*
* char buf[16];
* CHECK_NOTNULL(memccpy(buf, s, '\0', sizeof(buf)));
* char buf[16];
* CHECK_NOTNULL(memccpy(buf, s, '\0', sizeof(buf)));
*
* Or unstrictly:
*
* if (!memccpy(buf, s, '\0', sizeof(buf))) strcpy(buf, "?");
* if (!memccpy(buf, s, '\0', sizeof(buf))) strcpy(buf, "?");
*
* Are usually more sensible than the following:
*
* char cstrbuf[16];
* snprintf(cstrbuf, sizeof(cstrbuf), "%s", CSTR);
* char cstrbuf[16];
* snprintf(cstrbuf, sizeof(cstrbuf), "%s", CSTR);
*
* @return 𝑑 + idx(𝑐) + 1, or NULL if 𝑐 𝑠
* @note 𝑑 and 𝑠 can't overlap