From da09b7ff7e305b9a4f82e0048d1c4cc0a8565b64 Mon Sep 17 00:00:00 2001 From: Rob Landley Date: Thu, 20 Dec 2007 06:29:59 -0600 Subject: More random unfinished code documentation. --- www/code.html | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) mode change 100755 => 100644 www/code.html (limited to 'www/code.html') diff --git a/www/code.html b/www/code.html old mode 100755 new mode 100644 index 42b246d4..47fe6cdb --- a/www/code.html +++ b/www/code.html @@ -179,10 +179,23 @@ to the NEWTOY() name. (See toys/toylist.h)

toys/toylist.h

The first half of this file prototypes all the structures to hold -global variables for each command, and puts them in toy_union.

+global variables for each command, and puts them in toy_union. These +prototypes are only included if the macro NEWTOY isn't defined (in which +case NEWTOY is defined to a default value that produces function +prototypes).

-

The second half of this file lists all the commands (in alphabetical -order), along with their command line arguments and install location. This +

The second half of this file lists all the commands in alphabetical +order, along with their command line arguments and install location. +Each command has an appropriate configuration guard so only the commands that +are enabled wind up in the list.

+ +

The first time this header is #included, it defines structures and +produces function prototypes for the commands in the toys directory.

+ + +

The first time it's included, it defines structures and produces function +prototypes. + This is used to initialize toy_list in main.c, and later in that file to initialize NEED_OPTIONS (to figure out whether the command like parsing logic is needed), and to put the help entries in the right order in toys/help.c.

-- cgit v1.2.3