Skip to content

Commit fe28a18

Browse files
author
delphidabbler
committed
Add documentation of UnitList settings section omitted from earlier versions of document in error.
1 parent e4a789b commit fe28a18

File tree

1 file changed

+79
-1
lines changed

1 file changed

+79
-1
lines changed

Docs/Design/FileFormats/config.html

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ <h4>
315315
</dt>
316316
<dd>
317317
<div class="half-spaced">
318-
Once entry for each search directory configured for the compiler where <code class="key"<em>XXX</code> ranges from <code class="value">0</code> to <code class="key">SearchDirCount</code> - <code class="value">1</code>.
318+
One entry for each search directory configured for the compiler where <code class="key"<em>XXX</code> ranges from <code class="value">0</code> to <code class="key">SearchDirCount</code> - <code class="value">1</code>.
319319
</div>
320320
<div class="half-spaced">
321321
Each entry contains a fully specified directory path.
@@ -1230,6 +1230,84 @@ <h4>
12301230
</dl>
12311231
</div>
12321232

1233+
<h4>
1234+
[UnitList] section
1235+
</h4>
1236+
1237+
<p>
1238+
Records the names of the units that appear in the <em>Units</em> check box list on the <em>References</em> tab of the <em>Edit Snippet</em> dialoogue box.
1239+
</p>
1240+
1241+
<p>
1242+
Name / Value pairs:
1243+
</p>
1244+
1245+
<dl class="indent">
1246+
<dt>
1247+
<code class="key">Count</code> (Integer)
1248+
</dt>
1249+
<dd>
1250+
The number of units in the list.
1251+
</dd>
1252+
<dt>
1253+
<code class="key">Unit<em>XXX</em></code> (String)
1254+
</dt>
1255+
<dd>
1256+
One entry for each unit, where <code class="key">XXX</code> range from <code class="value">0</code> to <code class="key">Count</code> - <code class="value">1</code>.
1257+
</dd>
1258+
</dl>
1259+
1260+
<p>
1261+
Note that some &quot;reserved&quot; unit names that always appear in the list box are not recorded in settings. They are:
1262+
</p>
1263+
1264+
<ul class="unspaced">
1265+
<li>
1266+
<var>SysUtils</var>
1267+
</li>
1268+
<li>
1269+
<var>Classes</var>
1270+
</li>
1271+
<li>
1272+
<var>Windows</var>
1273+
</li>
1274+
<li>
1275+
<var>Graphics</var>
1276+
</li>
1277+
</ul>
1278+
1279+
<p>
1280+
If this section is missing or has no units listed then CodeSnip defaults to using the following units in addition to the &quot;reserved&quot; units:
1281+
</p>
1282+
1283+
<ul class="unspaced">
1284+
<li>
1285+
<var>Controls</var>
1286+
</li>
1287+
<li>
1288+
<var>Messages</var>
1289+
</li>
1290+
<li>
1291+
<var>Types</var>
1292+
</li>
1293+
<li>
1294+
<var>ShlObj</var>
1295+
</li>
1296+
<li>
1297+
<var>ShellAPI</var>
1298+
</li>
1299+
<li>
1300+
<var>ActiveX</var>
1301+
</li>
1302+
<li>
1303+
<var>Math</var>
1304+
</li>
1305+
</ul>
1306+
1307+
<p>
1308+
These default unit names will be included in this section the first time it is written.
1309+
</p>
1310+
12331311
<div class="del">
12341312
<h4>
12351313
[UpdateChecks] section

0 commit comments

Comments
 (0)