Added Danger and Notes sections to header template.

[SVN r13440]
This commit is contained in:
William E. Kempf 2002-04-10 22:09:30 +00:00
parent adcaf9dd59
commit c426b4bcea

View File

@ -2,7 +2,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{library}} - &lt;{{header}}&gt;</title>
<title>{{library}} - Header &lt;{{header}}&gt;</title>
</head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
@ -65,18 +65,18 @@
<h2><a name="types"></a>Types</h2>
<p><a name="type-spec"></a>{{Type specifications}}</p>
<h2><a name="classes"></a>Classes</h2>
<h3><a name="class-spec"></a>Class <code>{{name}}</code></h3>
<h3><a name="class-spec"></a>Class <code>{{class name}}</code></h3>
<p>{{class overview text}}</p>
<h4><a name="class-spec-synopsis"></a>Class {{name}} synopsis</h4>
<h4><a name="class-spec-synopsis"></a>Class <code>{{class name}}</code> synopsis</h4>
<pre>
namespace boost
{
class {{name}}
class {{class name}}
{
};
};
</pre>
<h4><a name="class-spec-ctors"></a>Class {{name}} constructors and destructor</h4>
<h4><a name="class-spec-ctors"></a>Class <code>{{class name}}</code> constructors and destructor</h4>
<pre>
{{constructor}}
</pre>
@ -88,6 +88,8 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<pre>
{{destructor}}
@ -100,8 +102,10 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-comparisons"></a>Class {{name}} comparison functions</h4>
<h4><a name="class-spec-comparisons"></a>Class <code>{{class name}}</code> comparison functions</h4>
<pre>
{{function}}
</pre>
@ -113,8 +117,10 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-modifiers"></a>Class {{name}} modifier functions</h4>
<h4><a name="class-spec-modifiers"></a>Class <code>{{class name}}</code> modifier functions</h4>
<pre>
{{function}}
</pre>
@ -126,8 +132,10 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-observers"></a>Class {{name}} observer functions</h4>
<h4><a name="class-spec-observers"></a>Class <code>{{class name}}</code> observer functions</h4>
<pre>
{{function}}
</pre>
@ -139,8 +147,10 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-statics"></a>Class {{name}} static functions</h4>
<h4><a name="class-spec-statics"></a>Class <code>{{class name}}</code> static functions</h4>
<pre>
{{function}}
</pre>
@ -152,6 +162,8 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h2><a name="functions"></a>Functions</h2>
<pre>
@ -165,6 +177,8 @@ namespace boost
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
</dl>
<h2><a name="objects"></a>Objects</h2>
<p><a name="object-spec"></a>{{Object specifications}}</p>