Fossil SCM

Updates to header-comment documentation for the mkindex utility program. Fix a compiler warning on windows builds.

drh 2011-01-01 03:06 trunk

Commit 79b7902cdd1a621b8e175bc2efc39a87315c5f27

Parent 26e269fef30b513…

2 files changed +2 +15 -2

M src/cgi.c

M src/mkindex.c

+15 -2

		--- src/mkindex.c
		+++ src/mkindex.c
		@@ -13,12 +13,15 @@
13	13	** [email protected]
14	14	** http://www.hwaci.com/drh/
15	15	**
16	16	*******************************************************************************
17	17	**
18		-** Build a static hash table that maps URLs into functions to generate
19		-** web pages.
	18	+** This program scans Fossil source code files looking for special
	19	+** comments that indicate a command-line command or a webpage. This
	20	+** routine collects information about these entry points and then
	21	+** generates (on standard output) C code used by Fossil to dispatch
	22	+** to those entry points.
20	23	**
21	24	** The source code is scanned for comment lines of the form:
22	25	**
23	26	** WEBPAGE: /abc/xyz
24	27	**
		@@ -34,10 +37,20 @@
34	37	**
35	38	** COMMAND: cmdname
36	39	**
37	40	** These entries build a constant table used to map command names into
38	41	** functions.
	42	+**
	43	+** Comment text following COMMAND: through the end of the comment is
	44	+** understood to be help text for the command specified. This help
	45	+** text is accumulated and a table containing the text for each command
	46	+** is generated. That table is used implement the "fossil help" command
	47	+** and the "/help" HTTP method.
	48	+**
	49	+** Multiple occurrances of WEBPAGE: or COMMAND: (but not both) can appear
	50	+** before each function name. In this way, webpages and commands can
	51	+** have aliases.
39	52	*/
40	53	#include <stdio.h>
41	54	#include <stdlib.h>
42	55	#include <ctype.h>
43	56	#include <assert.h>
44	57

	--- src/mkindex.c
	+++ src/mkindex.c
	@@ -13,12 +13,15 @@
13	** [email protected]
14	** http://www.hwaci.com/drh/
15	**
16	*******************************************************************************
17	**
18	** Build a static hash table that maps URLs into functions to generate
19	** web pages.



20	**
21	** The source code is scanned for comment lines of the form:
22	**
23	** WEBPAGE: /abc/xyz
24	**
	@@ -34,10 +37,20 @@
34	**
35	** COMMAND: cmdname
36	**
37	** These entries build a constant table used to map command names into
38	** functions.










39	*/
40	#include <stdio.h>
41	#include <stdlib.h>
42	#include <ctype.h>
43	#include <assert.h>
44

	--- src/mkindex.c
	+++ src/mkindex.c
	@@ -13,12 +13,15 @@
13	** [email protected]
14	** http://www.hwaci.com/drh/
15	**
16	*******************************************************************************
17	**
18	** This program scans Fossil source code files looking for special
19	** comments that indicate a command-line command or a webpage. This
20	** routine collects information about these entry points and then
21	** generates (on standard output) C code used by Fossil to dispatch
22	** to those entry points.
23	**
24	** The source code is scanned for comment lines of the form:
25	**
26	** WEBPAGE: /abc/xyz
27	**
	@@ -34,10 +37,20 @@
37	**
38	** COMMAND: cmdname
39	**
40	** These entries build a constant table used to map command names into
41	** functions.
42	**
43	** Comment text following COMMAND: through the end of the comment is
44	** understood to be help text for the command specified. This help
45	** text is accumulated and a table containing the text for each command
46	** is generated. That table is used implement the "fossil help" command
47	** and the "/help" HTTP method.
48	**
49	** Multiple occurrances of WEBPAGE: or COMMAND: (but not both) can appear
50	** before each function name. In this way, webpages and commands can
51	** have aliases.
52	*/
53	#include <stdio.h>
54	#include <stdlib.h>
55	#include <ctype.h>
56	#include <assert.h>
57