epics/pvAccess
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

update documentation

Browse Source
This commit is contained in:
Marty Kraimer
2014-07-10 13:21:12 -04:00
parent 194cf4ab0f
commit 4391d81fb2
4 changed files with 174 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/RELEASE_NOTES.md Normal file
View File

@ -0,0 +1,18 @@
Release release/3.1 IN DEVELOPMENT
===========
The main changes since release 3.0.2 are:
* pvAccess API is changed.
pvAccess API is changed.
------------
Instead of data (PVStructure) appearing in connect callback (for example channelGetConnect)
it now is present in method called by whoever delivers the data.
See pvAccessJava.html for details.
Release 3.0.4
==========
This was the starting point for RELEASE_NOTES

13
documentation/TODO.md Normal file
View File

@ -0,0 +1,13 @@
TODO
===========
pvAccessCPP.html
------------
This needs to be written.
For now it just refers tp pvAccessJava.html
Matej to add info
--------
This markdown document is for Matej to edit.

69
documentation/pvAccessCPP.html
View File

@ -10,12 +10,26 @@
<link rel="stylesheet" type="text/css"
href="http://epics-pvdata.sourceforge.net/epicsv4.css" />
<style type="text/css">
/*<![CDATA[*/
/*<![CDATA[*/
.about { margin-left: 3em; margin-right: 3em; font-size: .83em}
table { margin-left: auto; margin-right: auto }
.diagram { text-align: center; margin: 2.5em 0 }
body { margin-right: 10% }
/*]]>*/</style>
span.opt { color: grey }
span.nterm { font-style:italic }
span.term { font-family:courier }
span.user { font-family:courier }
span.user:before { content:"<" }
span.user:after { content:">" }
.nonnorm { font-style:italic }
p.ed { color: #AA0000 }
span.ed { color: #AA0000 }
p.ed.priv { display: inline; }
span.ed.priv { display: inline; }
/*]]>*/</style>
<!-- Script that generates the Table of Contents -->
<script type="text/javascript"
src="http://epics-pvdata.sourceforge.net/script/tocgen.js">
</script>
</head>
<body>
@ -24,44 +38,48 @@
<h1>EPICS pvAccessCPP</h1>
<!-- Maturity: Working Draft or Request for Comments, or Recommendation, and date. -->
<h2 class="nocount" id="L50">EPICS v4 Working Group, Working Draft,
20-Dec-2011</h2>
<h2 class="nocount" id="L50">EPICS v4 Working Group, Working Draft, 09-July-2011</h2>
<dl>
<dt>Latest version:</dt>
<dd><a
href="pvAccessCPP.html">pvAccessCPP.html</a></dd>
href="pvAccessCPP.html">pvAccessCPP.html
</a></dd>
<dt>This version:</dt>
<dd><a
href="pvAccessCPP_20111220.html">pvAccessCPP_20111220.html</a></dd>
href="pvAccessCPP_20140709.html">pvAccessCPP_20140709.html
</a></dd>
<dt>Previous version:</dt>
<dd><a
href="pvAccessCPP_20111220.html">pvAccessCPP_20111220.html
</a></dd>
<dt>Editors:</dt>
<dd>Marty Kraimer, BNL</dd>
<dd>Marty Kraimer, BNL<br />
Matej Sekoranja, CosyLab</dd>
</dl>
<hr />
</div>
<h2 class="nocount" id="L72">Abstract</h2>
<p>pvAccessCPP is the Java implementation of pvAccess, which is one of a related
<h2 class="nocount">Abstract</h2>
<p>pvAccessCPP is the C++ implementation of pvAccess, which is one of a related
set of products:</br >
<a href="http://epics-pvdata.sourceforge.net/relatedDocumentsV4.html">relatedDocumentsV4.html</a>
</p>
<h2 class="nocount" id="L80">Status of this Document</h2>
<h2 class="nocount">Status of this Document</h2>
<p>This is the 20-Dec-2011 version of the C++ implementation of pvAccess. The
<p>This is the 09-July-2011 version of the C++ implementation of pvAccess. The
code is a complete implementation of pvAccess as currently defined. This
overview is NOT written.</p>
CONTENTS
<div class="toc">
<ul>
<li><a href="#L50">EPICS v4 Working Group, Working Draft, 20-Dec-2011</a></li>
<li><a href="#L72">Abstract</a></li>
<li><a href="#L80">Status of this Document</a></li>
<li><a href="#L88">Introduction</a></li>
</ul>
</div>
<hr />
<div id="toc">
<h2 class="nocount" style="page-break-before: always">Table of Contents</h2>
</div>
<div id="contents" class="contents">
<h2 id="L88">Introduction</h2>
<hr />
@ -73,8 +91,9 @@ license</a></p>
<p>This overview for pvAccessCPP. Doxygen documentation is available at <a
href="./html/index.html">doxygenDoc</a></p>
<p><b>THIS IS NOT WRITTEN</b> For now please consult the overview documentation
for pvAccessJava. In addition look at the Doxygen documentation for this
project.</p>
<p><b>THIS IS NOT WRITTEN</b> For now please consult pvAccessJava.html.
In addition look at the Doxygen documentation for this project.</p>
</div>
</body>
</html>

99
documentation/pvAccessCPP_20140709.html Normal file
View File

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>EPICS pvAccessCPP</title>
<link rel="stylesheet" type="text/css"
href="http://epics-pvdata.sourceforge.net/base.css" />
<link rel="stylesheet" type="text/css"
href="http://epics-pvdata.sourceforge.net/epicsv4.css" />
<style type="text/css">
/*<![CDATA[*/
.about { margin-left: 3em; margin-right: 3em; font-size: .83em}
table { margin-left: auto; margin-right: auto }
.diagram { text-align: center; margin: 2.5em 0 }
span.opt { color: grey }
span.nterm { font-style:italic }
span.term { font-family:courier }
span.user { font-family:courier }
span.user:before { content:"<" }
span.user:after { content:">" }
.nonnorm { font-style:italic }
p.ed { color: #AA0000 }
span.ed { color: #AA0000 }
p.ed.priv { display: inline; }
span.ed.priv { display: inline; }
/*]]>*/</style>
<!-- Script that generates the Table of Contents -->
<script type="text/javascript"
src="http://epics-pvdata.sourceforge.net/script/tocgen.js">
</script>
</head>
<body>
<div class="head">
<h1>EPICS pvAccessCPP</h1>
<!-- Maturity: Working Draft or Request for Comments, or Recommendation, and date. -->
<h2 class="nocount" id="L50">EPICS v4 Working Group, Working Draft, 09-July-2011</h2>
<dl>
<dt>Latest version:</dt>
<dd><a
href="pvAccessCPP.html">pvAccessCPP.html
</a></dd>
<dt>This version:</dt>
<dd><a
href="pvAccessCPP_20140709.html">pvAccessCPP_20140709.html
</a></dd>
<dt>Previous version:</dt>
<dd><a
href="pvAccessCPP_20111220.html">pvAccessCPP_20111220.html
</a></dd>
<dt>Editors:</dt>
<dd>Marty Kraimer, BNL<br />
Matej Sekoranja, CosyLab</dd>
</dl>
<hr />
<h2 class="nocount">Abstract</h2>
<p>pvAccessCPP is the C++ implementation of pvAccess, which is one of a related
set of products:</br >
<a href="http://epics-pvdata.sourceforge.net/relatedDocumentsV4.html">relatedDocumentsV4.html</a>
</p>
<h2 class="nocount">Status of this Document</h2>
<p>This is the 09-July-2011 version of the C++ implementation of pvAccess. The
code is a complete implementation of pvAccess as currently defined. This
overview is NOT written.</p>
</div>
<div id="toc">
<h2 class="nocount" style="page-break-before: always">Table of Contents</h2>
</div>
<div id="contents" class="contents">
<h2 id="L88">Introduction</h2>
<hr />
<p>This product is available via an <a
href="http://epics-pvdata.sourceforge.net/LICENSE.html">open source
license</a></p>
<p>This overview for pvAccessCPP. Doxygen documentation is available at <a
href="./html/index.html">doxygenDoc</a></p>
<p><b>THIS IS NOT WRITTEN</b> For now please consult pvAccessJava.html.
In addition look at the Doxygen documentation for this project.</p>
</div>
</body>
</html>