Updated Generator.Convert documentation to match what the tool actually does.

This commit is contained in:
the_fiddler 2011-07-26 11:54:09 +00:00
parent 81b188ffca
commit c6b6cb7e68

View file

@ -5,10 +5,12 @@ This is a simple tool to convert C headers to XML files. It works using simple p
[Usage] [Usage]
CHeaderToXML.exe -p:{PREFIX} -v:{VERSION} {INPUT} Convert.exe -p:{PREFIX} -v:{VERSION} -t:{TYPE} -o:{OUT} {INPUT1} ... {INPUTn}
{PREFIX} is a simple string that defines the a common prefix for functions and constants in this header. This prefix will be removed from the generated XML file. {PREFIX} is a simple string that defines the a common prefix for functions and constants in this header. This prefix will be removed from the generated XML file.
{VERSION} is a string that defines that version that will be used for functions in the generated XML file. Specific input files may override this setting. {VERSION} is a string that defines that version that will be used for functions in the generated XML file. Specific input files may override this setting.
{INPUT} is a space-separated list of input files (headers). {TYPE} can be either 'spec' or 'header' to indicate whether the input files are OpenGL .spec files or C headers.
{OUT} is the output filename (optional). If no output file is specified, output will be directed to the console.
{INPUT1..n} is a space-separated list of input files (headers).
Despite what the help says, all three parameters are necessary at the moment. Despite what the help says, all three parameters are necessary at the moment.