Skip to content

Commit 095cb36

Browse files
committed
Merge pull request #6 from jurko-gospodnetic/develop
Documentation cleanups from Jurko Gospodnetić: - trim trailing spaces - fix documentation typos & style - escape first dash ('-') in double-dashes ('--') in doxygen comments This should prevent doxygen from generating bad documentation HTML pages containing '<ndash></ndash>' where those double-dashes should be.
2 parents 1a17f20 + a9ea9bb commit 095cb36

File tree

7 files changed

+144
-144
lines changed

7 files changed

+144
-144
lines changed

doc/design.xml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
not mean strict 7-bit ASCII encoding, but rather "char" strings in local
2323
8-bit encoding.
2424
</para>
25-
25+
2626
<para>
2727
Generally, &quot;Unicode support&quot; can mean
2828
many things, but for the program_options library it means that:
@@ -54,7 +54,7 @@
5454
passed to an ascii value will be converted using a codecvt
5555
facet (which may be specified by the user).
5656
</para>
57-
</listitem>
57+
</listitem>
5858
</itemizedlist>
5959
</para>
6060
</listitem>
@@ -68,8 +68,8 @@
6868
Second, imagine a reusable library which has some options and exposes
6969
options description in its interface. If <emphasis>all</emphasis>
7070
options are either ascii or Unicode, and the library does not use any
71-
Unicode strings, then the author will likely to use ascii options, which
72-
would make the library unusable inside Unicode
71+
Unicode strings, then the author is likely to use ascii options, making
72+
the library unusable inside Unicode
7373
applications. Essentially, it would be necessary to provide two versions
7474
of the library -- ascii and Unicode.
7575
</para>
@@ -94,7 +94,7 @@
9494
<para>The primary question in implementing the Unicode support is whether
9595
to use templates and <code>std::basic_string</code> or to use some
9696
internal encoding and convert between internal and external encodings on
97-
the interface boundaries.
97+
the interface boundaries.
9898
</para>
9999

100100
<para>The choice, mostly, is between code size and execution
@@ -171,14 +171,14 @@
171171
number of new instantiations.
172172
</para>
173173
</listitem>
174-
174+
175175
</itemizedlist>
176176
There's no clear leader, but the last point seems important, so UTF-8
177-
will be used.
177+
will be used.
178178
</para>
179179

180-
<para>Choosing the UTF-8 encoding allows the use of existing parsers,
181-
because 7-bit ascii characters retain their values in UTF-8,
180+
<para>Choosing the UTF-8 encoding allows the use of existing parsers,
181+
because 7-bit ascii characters retain their values in UTF-8,
182182
so searching for 7-bit strings is simple. However, there are
183183
two subtle issues:
184184
<itemizedlist>
@@ -197,16 +197,16 @@
197197
almost universal encoding and since composing characters following '=' (and
198198
other characters with special meaning to the library) are not likely to appear.
199199
</para>
200-
200+
201201
</section>
202202

203-
203+
204204
</section>
205205

206206
<!--
207207
Local Variables:
208208
mode: xml
209-
sgml-indent-data: t
209+
sgml-indent-data: t
210210
sgml-parent-document: ("program_options.xml" "section")
211211
sgml-set-face: t
212212
End:

0 commit comments

Comments
 (0)