update v1.0.x docs
[m6w6/ext-propro] / v1.0.x / index.html
index fcc4194854ed01bbe231271b91e8a0aea4d4197d..8615dd5a35bbef5cddf2406cd7ab0d38819f27cb 100644 (file)
@@ -3,22 +3,24 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.5"/>
+<meta name="generator" content="Doxygen 1.8.10"/>
 <title>Property proxy API: Main Page</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript">
   $(document).ready(initResizable);
   $(window).load(resizeHeight);
 </script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/javascript">
-  $(document).ready(function() { searchBox.OnSelectItem(0); });
+  $(document).ready(function() { init_search(); });
 </script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
@@ -28,7 +30,7 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
-  <td style="padding-left: 0.5em;">
+  <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Property proxy API
    </div>
    <div id="projectbrief">A facility to manage extension object properties tied to C-struct members</div>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.5 -->
+<!-- Generated by Doxygen 1.8.10 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li>
@@ -85,7 +88,7 @@ $(document).ready(function(){initNavTree('index.html','');});
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
-<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a></div>
+</div>
 
 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
@@ -99,14 +102,38 @@ $(document).ready(function(){initNavTree('index.html','');});
 <div class="title">Property proxy API Documentation</div>  </div>
 </div><!--header-->
 <div class="contents">
-</div><!-- contents -->
+<div class="textblock"><p><a href="https://travis-ci.org/m6w6/ext-propro">![Build Status](https://travis-ci.org/m6w6/ext-propro.svg?branch=v1.0.x)</a></p>
+<p>The "Property Proxy" extension provides a fairly transparent proxy for internal object properties hidden in custom non-zval implementations.</p>
+<h2>Documentation</h2>
+<p>See the <a href="https://mdref.m6w6.name/propro">online markdown reference</a>.</p>
+<p>Known issues are listed in <a href="./BUGS">BUGS</a> and future ideas can be found in <a href="./TODO">TODO</a>.</p>
+<h2>Installing</h2>
+<h3>PECL</h3>
+<pre class="fragment">pecl install propro
+</pre><h3>PHARext</h3>
+<p>Watch out for <a href="https://replicator.pharext.org?propro">PECL replicates</a> and pharext packages attached to <a href="./releases">releases</a>.</p>
+<h3>Checkout</h3>
+<pre class="fragment">git clone github.com:m6w6/ext-propro
+cd ext-propro
+/path/to/phpize
+./configure --with-php-config=/path/to/php-config
+make
+sudo make install
+</pre><h2>ChangeLog</h2>
+<p>A comprehensive list of changes can be obtained from the <a href="https://pecl.php.net/package-changelog.php?package=propro">PECL website</a>.</p>
+<h2>License</h2>
+<p>ext-propro is licensed under the 2-Clause-BSD license, which can be found in the accompanying <a href="./LICENSE">LICENSE</a> file.</p>
+<h2>Contributing</h2>
+<p>All forms of contribution are welcome! Please see the bundled ./CONTRIBUTING.md "CONTRIBUTING" note for the general principles followed.</p>
+<p>The list of past and current contributors is maintained in <a href="./THANKS">THANKS</a>. </p>
+</div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">Generated by
     <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
   </ul>
 </div>
 </body>