boost/wave
2
0
Fork 0
mirror of https://github.com/boostorg/wave.git synced 2026-01-19 04:42:16 +00:00
Code Issues Projects Releases Wiki Activity

Fixed documentation.

Browse Source 
[SVN r36680]
This commit is contained in:
Hartmut Kaiser
2007-01-10 01:49:22 +00:00
parent 3cf132c4d0
commit d5fdcf6697
2 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/supported_pragmas.html
View File

@@ -57,13 +57,13 @@
<td> <p class="toc_title" width="36%">description</p></td>
</tr>
<tr>
<td class="table_cells" width="19%"> <p>trace</p></td>
<td class="table_cells" width="18%"> <p>enable/on/1<br>
disable/off/0</p></td>
<td class="table_cells" width="43%"><p>Enable or disable the tracing of the
<td class="table_cells" width="15%"> <p>trace</p></td>
<td class="table_cells" width="31%"> <p>enable/on/1<br>
disable/off/0</p></td>
<td class="table_cells" width="54%"><p>Enable or disable the tracing of the
macro expansion process. This is needed, even if there is given the --trace
command line option, because the trace output is generated only, if there
is at least one trace(enable) pragma found.</p></td>
is at least one trace(enable) pragma found.</p></td>
</tr>
<tr>
<td class="table_cells"><p>stop</p></td>
@@ -101,12 +101,12 @@
<td class="table_cells"><p>option</p></td>
<td class="table_cells"><p>line: [0|1]<br>
preserve: [0|1|2]<br>
output: [&quot;filename&quot; | null]
output: [&quot;filename&quot; | null | default]
</p>
</td>
<td class="table_cells"><p>The <tt>option(line: ...)</tt> directive allows to control, whether <span class="preprocessor">#line</span> directives will be generated in the output stream. Specify either '0' or '1' as the option parameter. All other values will be flaged as illegal. </p>
<p>The <tt>option(preserve: ...)</tt> directive allows to control the amount of whitespace generated in the output stream. The value '0' removes any not needed whitespace, the value '1' keeps comments only and the value '2' does not remove any whitespace.</p>
<p>The <tt>option(output: ...)</tt> directive allows to specify the name of the file, where the output is generated to. Specify either a valid filename (which will be interpreted relative to directory of the processed file) or the value <tt>null</tt> (without quotes) to disable the output at all. </p></td>
<p>The <tt>option(output: ...)</tt> directive allows to specify the name of the file, where the output is generated to. Specify either a valid filename (which will be interpreted relative to directory of the processed file), the value <tt>null</tt> to disable the output at all, or the value <tt>default</tt> to use the output as specified on the command line using the --output/-o option. </p></td>
</tr>
</table>
<p>All pragma's not listed here but flagged as <tt>'wave'</tt> are currently reported as
@@ -133,7 +133,7 @@
<font size="2">Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) </font> </p>
<span class="updated"></span>
<p class="copyright"><span class="updated">Last updated:
<!-- #BeginDate format:fcAm1m -->Tuesday, May 2, 2006 17:28<!-- #EndDate -->
<!-- #BeginDate format:fcAm1m -->Tuesday, January 9, 2007 19:46<!-- #EndDate -->
</span>
</p>
<p>&nbsp;</p>

9
doc/wave_driver.html
View File

@@ -78,7 +78,7 @@
<P dir="ltr">-o [--output] path</P>
<blockquote>
<p dir="ltr">Specify a filename to be used for the generated preprocessed output
stream. If this option is not given, then the standard output is used (stdout). If the filename given equals to <tt>'-'</tt> (without the quotes), no output is generated initially. This is especially useful for syntax checks only or in conjunction with the <span class="preprocessor">#pragma&nbsp;wave&nbsp;option(output:&nbsp;...) </span>directive restricting the generated out to specific parts only. </p>
stream. If this option is not given, then the standard output is used (stdout). If the filename given equals to <tt>'-'</tt> (without the quotes), no output is generated initially. This is especially useful for syntax checks only or in conjunction with the <span class="preprocessor">#pragma&nbsp;wave&nbsp;option(output:&nbsp;...) </span>directive restricting the generated out to specific parts only (for a description see the section <a href="supported_pragmas.html">Supported Pragma Directives</a>). </p>
</blockquote>
<P dir="ltr">-E [--autooutput]</P>
<blockquote>
@@ -247,8 +247,9 @@ is now disabled by default because it may cause a potential security threat. The
line.</p>
</blockquote>
<p dir="ltr">The <tt>Wave</tt> driver program at startup looks for a configuration
file named 'wave.cfg' in the same directory where it was started from (where the driver executable
is located). If this file exists, it is treated as a normal
file named 'wave.cfg' in every directory up the file system hierarchy starting
from the directory where the input file is located. The first file found stops
the search. If a file exists, it is treated as a normal
configuration file and the specified herein options are interpreted as if they
were given as the first options on the command line. This feature is very useful
for defining a global environment for the <tt>Wave</tt> preprocessor driver.</p>
@@ -266,7 +267,7 @@ is now disabled by default because it may cause a potential security threat. The
<font size="2">Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) </font> </p>
<span class="updated"></span>
<p class="copyright"><span class="updated">Last updated:
<!-- #BeginDate format:fcAm1m -->Monday, March 13, 2006 19:18<!-- #EndDate -->
<!-- #BeginDate format:fcAm1m -->Tuesday, January 9, 2007 19:42<!-- #EndDate -->
</span></p>
</body>
</html>