changes to documentation

This commit is contained in:
mrkraimer
2017-06-29 09:47:14 -04:00
parent d8ab89e96a
commit 594d8dd19f
4 changed files with 157 additions and 19 deletions
+8 -16
View File
@@ -26,11 +26,11 @@
<div class="head">
<h1>EPICS pvaClientCPP</h1>
<h2 class="nocount">Release 4.2.0-SNAPSHOT - 2016-07-14</h2>
<h2 class="nocount">Release 4.7.0-SNAPSHOT - 2017-06-29</h2>
<h2 class="nocount">Abstract</h2>
<p>pvaClient is a software library that provides to an EPICS client programmer, a friendly
<p>pvaClient is a software library that provides, to an EPICS client programmer, a friendly
client side programming interface to the data of an EPICS based control system. It is intended
for such uses as rapid development of ad hoc programs by controls engineers, or to provide
scientists a way to directly develop analytical applications.</p>
@@ -62,11 +62,6 @@ The data for the channels is presented via normative type NTMultiChannel.
</div> <!-- head -->
<div id="toc">
<h2 class="nocount">Table of Contents</h2>
</div>
<!-- Place what you would like in the Table of Contents, inside the contents div -->
<div id="contents" class="contents">
<hr />
<h2>Overview</h2>
@@ -76,10 +71,10 @@ pvaClientCPP is one of the components of
EPICS Version 4
</a>
</p>
<p>This document is only a guide to help locate code and documentation related to pvDatabaseCPP
<p>This document is only a guide to help locate code and documentation related to pvaClientCPP
</p>
<p>
It is intended for developers that want to use pvDatabaseCPP.
It is intended for developers that want to use pvaClientCPP.
</p>
<h2>Developer Guide</h2>
<p>A guide for developers is available at
@@ -88,14 +83,11 @@ href="http://epics-pvdata.sourceforge.net/informative/developerGuide/developerGu
developerGuide
</a>
</p>
<p>This guide discusses all the components that are part of an <b>EPICS V4</b> release.
<p>This guide provides an overview of the components that are part of an <b>EPICS V4</b> release.
Some understanding of the components and how they are related is necessary in order to
develop code that uses pvDatabaseCPP.
develop code that uses pvaClientCPP.
In particular read everything related to pvaClient.
</p>
<p>The developerGuide discusses code in a way that applies to both CPP and C++.
For the descriptions of the CPP specific code consult the next section.
</p>
<h2>doxygen</h2>
<p>doxygen documentation is available at
@@ -104,9 +96,9 @@ href="./html/index.html">doxygen</a>
</p>
<h2>exampleCPP</h2>
<p>Example code is available as part of this release.
<p>Example code is available at
<a
href="http://epics-pvdata.sourceforge.net/docbuild/exampleCPP/tip/documentation/exampleCPP.html">
href="https://github.com/epics-base/exampleCPP">
exampleCPP
</a>
</p>