Skip to content

Commit ca5fea5

Browse files
committed
#204-create PCS documentation
Fixed HTML documentation access.
1 parent afadeea commit ca5fea5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

cpp-strings/html/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md1"></a>
101101
<li>Class <span class="tt">pcs::CppString</span> specializes the templated class with <span class="tt">char</span> characters.</li>
102102
<li>Class <span class="tt">pcs::CppWString</span> specializes the templated class with <span class="tt">wchar_t</span> characters.</li>
103103
</ul>
104-
<p>The <b>cpp-strings</b> HTML documentation is available here: <a href="html/index.html">html/index.html</a>.</p>
104+
<p>The cpp-strings <b>HTML documentation</b> is available in subdirectory <span class="tt">cpp-strings/html</span>. Click on file <span class="tt">index.html</span> there from your local file manager to browse its content.</p>
105105
<p>Library <b>cpp-strings</b> is implemented with the currently most recent c++ standard available with gcc, clang and msvc c++ compilers, i.e. standard <b>c++20</b>.</p>
106106
<ul>
107107
<li>directory <span class="tt">cpp-strings</span> contains the header file <span class="tt">cppstring.h</span>. <br />
@@ -171,7 +171,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
171171
<hr />
172172
<h1 class="doxsection"><a class="anchor" id="autotoc_md9"></a>
173173
Documentation</h1>
174-
<p>The <b>cpp-strings</b> HTML documentation is available here: <a href="html/index.html">html/index.html</a>.</p>
174+
<p>The <b>cpp-strings</b> HTML documentation is available in subdirectory <span class="tt">cpp-strings/html</span>. Click on file <span class="tt">index.html</span> there from your local file manager to browse its content.</p>
175175
<p>It has then been produced with the great utility <b>doxygen</b> developed by Vicente Hernando (the doxygen Github repository can be accessed <a href="https://github.com/doxygen/doxygen">here</a>, and the utility can be downloaded from there: <a href="https://www.doxygen.nl/download.html">https://www.doxygen.nl/download.html</a>).</p>
176176
<p>This is a short documentation of the library. For some of its part it is a copy of the Python original documentation on strings. For its other part it documents the c++ implementation of <b>cpp-strings</b>.</p>
177177
<p>And remember: to better understand how to use this pythonic c++ strings library, have a look also at <a href="cpp-strings-tests/cpp-strings-tests.cpp"><span class="tt">cpp-strings-tests/cpp-strings-tests.cpp</span></a> to see <b>cpp-strings</b> library code in action! </p>

0 commit comments

Comments
 (0)