Add markup for constants.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@11135 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2001-10-13 18:52:54 +00:00
parent 220e6f495e
commit cb0707d9ef
2 changed files with 79 additions and 9 deletions

View file

@ -116,6 +116,21 @@
conforming (or not conforming) to the specified standards.
</item>
</list>
<p>
Generally, the text in comments is reformatted to standardise and
indent it nicely ... the reformatting is <em>not</em> performed on
any text inside an &lt;example&gt; element.<br />
When the text is reformatted, it is broken into whitespace separated
'words' which are then subjected to some extra processing ...
</p>
<list>
<item>Certain well known constants such as YES, NO, and nil are
enclosed in &lt;code&gt; ... &lt;/code&gt; markup.
</item>
<item>Method names (beginning with a plus or minus) are enclosed
in &lt;ref...&gt; ... &lt;/ref&gt; markup.
</item>
</list>
<p>
The tools accepts certain user defaults (which can of course be
supplied as command-line arguments as usual) -