Code vs Document

[Michael StJohns <msj@nthpermutation.com>]

I've been looking at the existing documents, mainly trying to figure out 
if there is an "easier" way of ensuring correspondence between the 
document and the header files.

I'm wondering if it would be possible to tag places in the document 
where various C-code items are defined.  Word has a mechanism for hiding 
specific text by flipping a switch and by tagging the text as "hidden" - 
so the editing of the document could be done with the tags visible, but 
produced as a final document by hiding the tags:


E.g. something like:

<struct>

    typedef struct CK_SLOT_INFO {
      CK_UTF8CHAR slotDescription[64];
      CK_UTF8CHAR manufacturerID[32];
      CK_FLAGS flags;
      CK_VERSION hardwareVersion;
      CK_VERSION firmwareVersion;
    } CK_SLOT_INFO;

</struct>

where the <> tags have the hidden attribute.

Once things are tagged appropriately, it would be pretty easy to run a 
program to extract all of those tagged items into a header file and then 
do some post processing.  It would probably be a pain to start, but once 
done it would probably aid in keeping things consistent.

Mike