From b5230e06855a17e86ffed406cc89d905f64f8438 Mon Sep 17 00:00:00 2001 From: nothings Date: Tue, 3 Jun 2014 10:21:39 -0700 Subject: [PATCH] Add comments describing all stb_ functions Added comments for all stb_ functions since I'm now using this program as an illustrative example of the value of something like stb_ functions. --- tools/make_readme.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/tools/make_readme.c b/tools/make_readme.c index c327a0f..03aee3a 100644 --- a/tools/make_readme.c +++ b/tools/make_readme.c @@ -5,32 +5,32 @@ int main(int argc, char **argv) { int i; int hlen, flen, listlen; - char *header = stb_file("README.header.md", &hlen); - char *footer = stb_file("README.footer.md", &flen); - char **list = stb_stringfile("README.list", &listlen); + char *header = stb_file("README.header.md", &hlen); // stb_file - read file into malloc()ed buffer + char *footer = stb_file("README.footer.md", &flen); // stb_file - read file into malloc()ed buffer + char **list = stb_stringfile("README.list", &listlen); // stb_stringfile - read file lines into malloced array of strings FILE *f = fopen("../README.md", "wb"); fwrite(header, 1, hlen, f); for (i=0; i < listlen; ++i) { int num,j; - char **tokens = stb_tokens_stripwhite(list[i], "|", &num); - FILE *g = fopen(stb_sprintf("../%s", tokens[0]), "rb"); + char **tokens = stb_tokens_stripwhite(list[i], "|", &num); // stb_tokens -- tokenize string into malloced array of strings + FILE *g = fopen(stb_sprintf("../%s", tokens[0]), "rb"); // stb_sprintf -- sprintf to a temporary buffer (not threadsafe) char buffer[256], *s1, *s2; fread(buffer, 1, 256, g); fclose(g); buffer[255] = 0; s1 = strchr(buffer, '-'); - if (!s1) stb_fatal("Couldn't find '-' before version number in %s", tokens[0]); + if (!s1) stb_fatal("Couldn't find '-' before version number in %s", tokens[0]); // stb_fatal -- print error message & exit s2 = strchr(s1+2, '-'); - if (!s2) stb_fatal("Couldn't find '-' after version number in %s", tokens[0]); + if (!s2) stb_fatal("Couldn't find '-' after version number in %s", tokens[0]); // stb_fatal -- print error message & exit *s2 = 0; s1 += 1; - s1 = stb_trimwhite(s1); + s1 = stb_trimwhite(s1); // stb_trimwhite -- advance pointer to after whitespace & delete trailing whitespace if (*s1 == 'v') ++s1; fprintf(f, "**%s** | %s", tokens[0], s1); - s1 = stb_trimwhite(tokens[1]); - s2 = stb_dupreplace(s1, " ", " "); + s1 = stb_trimwhite(tokens[1]); // stb_trimwhite -- advance pointer to after whitespace & delete trailing whitespace + s2 = stb_dupreplace(s1, " ", " "); // stb_dupreplace -- search & replace string and malloc result fprintf(f, " | %s", s2); free(s2); for (j=2; j < num; ++j) @@ -42,4 +42,4 @@ int main(int argc, char **argv) fclose(f); return 0; -} \ No newline at end of file +}