diff options
author | Carlo Teubner <carlo@cteubner.net> | 2022-07-30 12:03:16 +0100 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2022-07-30 12:03:16 +0100 |
commit | ddab3ce3457aadffb16ce0127f67a99966a065a8 (patch) | |
tree | 2af8366ff637bb9153ff37fd88c89bab83162c17 /runtime/doc/doctags.c | |
parent | 1eead4cf1daf87ee41aeb4de3b3e38708417f9d5 (diff) |
patch 9.0.0110: help tag generation picks up words in code examplesv9.0.0110
Problem: Help tag generation picks up words in code examples.
Solution: Skip over examples. (Carlo Teubner, closes #10813)
Diffstat (limited to 'runtime/doc/doctags.c')
-rw-r--r-- | runtime/doc/doctags.c | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/runtime/doc/doctags.c b/runtime/doc/doctags.c index f0dea2c87d..8822dcb9ac 100644 --- a/runtime/doc/doctags.c +++ b/runtime/doc/doctags.c @@ -21,6 +21,8 @@ main(int argc, char **argv) char *p1, *p2; char *p; FILE *fd; + int len; + int in_example; if (argc <= 1) { @@ -37,22 +39,28 @@ main(int argc, char **argv) fprintf(stderr, "Unable to open %s for reading\n", argv[0]); continue; } + in_example = 0; while (fgets(line, LINELEN, fd) != NULL) { - p1 = strchr(line, '*'); /* find first '*' */ + if (in_example) + { + // skip over example; non-blank in first column ends example + if (strchr(" \t\n\r", line[0]) != NULL) + continue; + in_example = 0; + } + p1 = strchr(line, '*'); // find first '*' while (p1 != NULL) { - p2 = strchr(p1 + 1, '*'); /* find second '*' */ - if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */ + p2 = strchr(p1 + 1, '*'); // find second '*' + if (p2 != NULL && p2 > p1 + 1) // skip "*" and "**" { for (p = p1 + 1; p < p2; ++p) if (*p == ' ' || *p == '\t' || *p == '|') break; - /* - * Only accept a *tag* when it consists of valid - * characters, there is white space before it and is - * followed by a white character or end-of-line. - */ + // Only accept a *tag* when it consists of valid + // characters, there is white space before it and is + // followed by a white character or end-of-line. if (p == p2 && (p1 == line || p1[-1] == ' ' || p1[-1] == '\t') && (strchr(" \t\n\r", p[1]) != NULL @@ -63,18 +71,22 @@ main(int argc, char **argv) printf("%s\t%s\t/*", p1, argv[0]); while (*p1) { - /* insert backslash before '\\' and '/' */ + // insert backslash before '\\' and '/' if (*p1 == '\\' || *p1 == '/') putchar('\\'); putchar(*p1); ++p1; } printf("*\n"); - p2 = strchr(p2 + 1, '*'); /* find next '*' */ + p2 = strchr(p2 + 1, '*'); // find next '*' } } p1 = p2; } + len = strlen(line); + if ((len == 2 && strcmp(&line[len - 2], ">\n") == 0) + || (len >= 3 && strcmp(&line[len - 3], " >\n") == 0)) + in_example = 1; } fclose(fd); } |