04-22-2005, 01:34 AM
Okay, here we go: It was actually pretty good. You definately have the freedoc format down solid. Just make sure that you leave the revision tag out of the header when you create a document, so it doesn't leave an mm/dd/yyyy there.
The other thing is the amount of detail that it describes. OR is much more than a bitwise operation. It is used in conditions, and is a primitive computation (OR gates are common in hardware design). It also might help to
I redid the document for reference, leaving you as the author and implementing the chart format you asked about. You can modify the document to how you see fit. I did this in two hours: my grammer, information and whole approach to explaining it may be off. But it's just to demonstrate the amount of detail you should consider when documenting a language element.
http://www.betterwebber.com/stuff/kw_or.xml
The other thing is the amount of detail that it describes. OR is much more than a bitwise operation. It is used in conditions, and is a primitive computation (OR gates are common in hardware design). It also might help to
I redid the document for reference, leaving you as the author and implementing the chart format you asked about. You can modify the document to how you see fit. I did this in two hours: my grammer, information and whole approach to explaining it may be off. But it's just to demonstrate the amount of detail you should consider when documenting a language element.
http://www.betterwebber.com/stuff/kw_or.xml