From 52fc1ceef8782c29a1cb49dc1f398c625a928aa1 Mon Sep 17 00:00:00 2001 From: Neil Edelman Date: Sun, 26 Mar 2017 22:00:13 -0400 Subject: [PATCH] Version 1.1: fixed all pedantic warnings; cdoc documented. --- doc/Files.html | 14 +++---- doc/Parser.html | 96 +++++++++++++++++++++++++++++++++++++++++++++-- doc/Recursor.html | 52 ++++++++++++------------- doc/Widget.html | 34 ++++++++++++++++- src/Files.c | 21 +++++++---- src/Files.h | 4 +- src/Parser.c | 9 +++-- src/Parser.h | 4 +- src/Recursor.c | 79 ++++++++++++++++++++++++++++++-------- src/Widget.c | 9 +++-- 10 files changed, 245 insertions(+), 77 deletions(-) diff --git a/doc/Files.html b/doc/Files.html index 4cfb7a0..b798cfb 100644 --- a/doc/Files.html +++ b/doc/Files.html @@ -50,7 +50,7 @@ a relation to other Files by 'parent' and 'favourite' (@(pwd) uses this.)

minimum standard
-
POSIX
+
POSIX.1
author
Neil
version
@@ -72,11 +72,11 @@ See Files.
-
-

typedef int (*FilesFilter)(struct Files *const, const char *)

-
typedef int (*FilesFilter)(struct Files *const, const char *)
+
+

typedef int (*FilesFilter)(struct Files *const files, const char *file)

+
typedef int (*FilesFilter)(struct Files *const files, const char *file)

-Returns a boolean value. +Returns a boolean value on whether files should include file.

@@ -197,7 +197,7 @@ Resets the list of favourites. 
const char * FilesEnumPath (struct Files *const files)
return
-
After FilesSetFarourite, this enumerates them.
+
After FilesSetPath, this enumerates them.
@@ -215,7 +215,7 @@ Resets the list of favourites. 
int FilesSize (const struct Files *files)
return
-
File size of the selected file.
+
File size of the selected file in KB.
diff --git a/doc/Parser.html b/doc/Parser.html index 94e5c8e..421931e 100644 --- a/doc/Parser.html +++ b/doc/Parser.html @@ -25,13 +25,13 @@ padding: 4px; } - +Parser -

+

Parser

+

+Copyright 2008, 2012 Neil Edelman, distributed under the terms of the +GNU General Public License, see copying.txt +

+

+Parsing of strings. '~' on a line by itself is recognised in ".newsfile.rss" +and ".sitemap.xml" as a <head>~<body>~<tail>; there should be two of them. +

+

+Parsed in ".index.html", +

+ +

+Further parsed in @(files) in ".index.html", +

+ +

+Parsed in ".newsfeed.rss", +

+
+
minimum standard
+
C89/90
+
author
+
Neil
+
version
+
1.1; 2017-03 fixed pedantic warnings; command-line improvements
+
since
+
0.6; 2008-03-21
@@ -59,7 +147,7 @@ See Parser.

struct Files

struct Files

-Dependancy on Files +Dependancy on Files.

@@ -69,7 +157,7 @@ Dependancy on Files

typedef int (*ParserWidget)(struct Files *const files, FILE *const fp)

typedef int (*ParserWidget)(struct Files *const files, FILE *const fp)

-All ParserWidgets are in Widget.c +All ParserWidgets are in Widget.c.

diff --git a/doc/Recursor.html b/doc/Recursor.html index df2e430..bc8b6f5 100644 --- a/doc/Recursor.html +++ b/doc/Recursor.html @@ -25,13 +25,13 @@ padding: 4px; } -Parser +Recursor -

Parser

+

Recursor