adding missing files, checking in doc changes

contracts/eos/eos.cpp

@@ -0,0 +1,114 @@
+/**
+  @defgroup eoscontract eos contract
+  @brief Documents the interface to the EOS currency contract
+  @ingroup contracts
+
+  @section eoscontractdesc Description
+*/
+
+namespace native { 
+
+   /**
+    *  @ingroup contracts
+    *  @brief Defines the base class for all contracts
+    */
+   struct contract {
+
+      /**
+       *  @brief updates the code that will be executed for this contract
+       *
+       *  <h3> Required Authority </h3> 
+       *
+       *  Requires authority of *this* contract.
+       *
+       *  <h3> Required Scope </h3> 
+       *
+       *  Requires scope of *this* contract.
+       *
+       *  @note the change in code does not take effect until the start of the next block
+       */
+      void setcode( Bytes code,
+                    Abi   abi, 
+                    uint8_t vm = 0, 
+                    uint8_t vm_version = 0 ) final;
+
+      /**
+       * @brief updates the authority required for a named permission
+       *
+       *  <h3> Required Authority </h3> 
+       *
+       *  Requires authority of *this* contract.
+       *
+       *  <h3> Required Scope </h3> 
+       *
+       *  Requires scope of *this* contract.
+       */
+      void setauth( Name permission, ///< the name for the permission being set
+                    Name parent, ///< the parent permission to this permission 
+                    Authority auth ///< the set of keys/accounts and threshold  );
+                   ) final;
+
+
+      /**
+       *  @brief set the local named permission required for `this` account/contract to
+       *     call `con::act(...)` 
+       *
+       *  <h3> Required Authority </h3> 
+       *
+       *  Requires authority of *this* contract.
+       *
+       *  <h3> Required Scope </h3> 
+       *
+       *  Requires scope of *this* contract.
+       *
+       *  @pre myperm must be defined by prior call to @ref setauth
+       *
+       *  @param con - the name of the contract this permission applies
+       *  @param act - the name of the action on @ref con this permission applies to
+       *  @param myperm - the name of a permission set by @ref setauth on `this` contract
+       */
+      void setperm( Name con, Name act, Name myperm );
+   };
+
+   /**
+    *   @class eos
+    *
+    *   @ingroup contracts
+    *
+    *   The EOS contract is a *native* currency contract implemented with account named `eos`. This contract enables
+    *   users to transfer EOS tokens to each other. This contract is designed to work the @ref stakedcontract and 
+    *   @ref systemcontract when creating new accounts, claiming staked EOS.
+    */
+   struct eos : public contract {
+
+      /**
+        @brief This action will transfer funds from one account to another.
+        
+        @pre `from`'s balance must be greaterthan or equal to `amount` transferred.
+        @pre The amount transferred must be greater than 0 
+        @pre `to` and `from` may not be the same account.
+      
+      <h3> Required Authority </h3>
+      
+      This action requires the authority of the `from` account.
+      
+      <h3>Required Scope </h3>
+      
+      This action requires access to `from` and `to` account scopes. It does not require
+      access to the `eos` scope which means that multiple transfers can execute in parallel
+      as long as they don't have any overlapping scopes.
+      
+      <h3> Required Recipients </h3>
+      
+      This message requires that the accounts `from` and `to` are listed in the required recipients. This ensures
+      other contracts are notified anytime EOS tokens are transferred.
+      
+      */
+      void transfer (
+         AccountName from,  ///< account from which EOS will be withdrawn   
+         AccountName to,    ///< account to receive EOS, may not be same as `from`
+         uint64_t    amount ///< must be greater than 0 and less or equal to `from`'s balance 
+      );
+
+ }; /// class EOS
+}

contracts/eoslib/mainpage.md

@@ -1,6 +1,8 @@
 Welcome to the eos.io Documentation
 -----------------------------------
 
+@note this documentation is under development and may be incorrect. 
+
 This documentaiton describes the APIs available to eos.io application developers. This is the best place to
 start your journey into smart contract development.
 

docs/annotated.html

@@ -0,0 +1,109 @@
+<!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/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>EOS.IO: Class List</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="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>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">EOS.IO
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle">
+<div class="title">Class List</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
+<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
+<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceeos.html" target="_self">eos</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classeos_1_1iostream.html" target="_self">iostream</a></td><td class="desc"></td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1_name.html" target="_self">Name</a></td><td class="desc">Wraps a uint64_t to ensure it is only passed to methods that expect a <a class="el" href="structeos_1_1_name.html" title="wraps a uint64_t to ensure it is only passed to methods that expect a Name and that no mathematical o...">Name</a> and that no mathematical operations occur. It also enables specialization of print so that it is printed as a base32 string </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1price.html" target="_self">price</a></td><td class="desc">Defines a fixed precision price between two tokens </td></tr>
+<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1remove__reference.html" target="_self">remove_reference</a></td><td class="desc"></td></tr>
+<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1remove__reference_3_01const_01_t_01_6_01_4.html" target="_self">remove_reference&lt; const T &amp; &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1remove__reference_3_01_t_01_6_01_4.html" target="_self">remove_reference&lt; T &amp; &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1token.html" target="_self">token</a></td><td class="desc">Uint64_t wrapper with checks for proper types and over/underflows </td></tr>
+<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1_transfer.html" target="_self">Transfer</a></td><td class="desc">Binary structure of the <code>transfer</code> message type for the <code>eos</code> contract </td></tr>
+<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structeos_1_1uint128.html" target="_self">uint128</a></td><td class="desc">Struct that wraps <a class="el" href="structeos_1_1uint128.html" title="a struct that wraps uint128 integer and defines common operator overloads ">uint128</a> integer and defines common operator overloads </td></tr>
+<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceexchange.html" target="_self">exchange</a></td><td class="desc"></td></tr>
+<tr id="row_1_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structexchange_1_1_buy_order.html" target="_self">BuyOrder</a></td><td class="desc"></td></tr>
+<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structexchange_1_1_order_i_d.html" target="_self">OrderID</a></td><td class="desc"></td></tr>
+<tr id="row_1_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structexchange_1_1_sell_order.html" target="_self">SellOrder</a></td><td class="desc"></td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacenative.html" target="_self">native</a></td><td class="desc"></td></tr>
+<tr id="row_2_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnative_1_1contract.html" target="_self">contract</a></td><td class="desc">Defines the base class for all contracts </td></tr>
+<tr id="row_2_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnative_1_1eos.html" target="_self">eos</a></td><td class="desc"></td></tr>
+<tr id="row_3_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_t_o_k_e_n___n_a_m_e.html" target="_self">TOKEN_NAME</a></td><td class="desc">Defines transfer struct (abi) </td></tr>
+<tr id="row_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_t_o_k_e_n___n_a_m_e_1_1_account.html" target="_self">Account</a></td><td class="desc">Row in <a class="el" href="struct_t_o_k_e_n___n_a_m_e_1_1_account.html" title="row in Account table stored within each scope ">Account</a> table stored within each scope </td></tr>
+<tr id="row_3_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_t_o_k_e_n___n_a_m_e_1_1_transfer.html" target="_self">Transfer</a></td><td class="desc"></td></tr>
+<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_account.html" target="_self">Account</a></td><td class="desc"></td></tr>
+<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_post_action.html" target="_self">PostAction</a></td><td class="desc"></td></tr>
+<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_post_record.html" target="_self">PostRecord</a></td><td class="desc"></td></tr>
+<tr id="row_7_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_7_" class="arrow" onclick="toggleFolder('7_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table.html" target="_self">Table</a></td><td class="desc">Defines a type-safe C++ wrapper around the <a class="el" href="group__database_c.html">Database C API</a> </td></tr>
+<tr id="row_7_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_1_1_primary_index.html" target="_self">PrimaryIndex</a></td><td class="desc"></td></tr>
+<tr id="row_7_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_1_1_secondary_index.html" target="_self">SecondaryIndex</a></td><td class="desc"></td></tr>
+<tr id="row_8_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_8_" class="arrow" onclick="toggleFolder('8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4.html" target="_self">Table&lt; scope, code, table, Record, PrimaryType, void &gt;</a></td><td class="desc">This specialization of <a class="el" href="struct_table.html" title="defines a type-safe C++ wrapper around the Database C API ">Table</a> is for single-index tables </td></tr>
+<tr id="row_8_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_3_01scope_00_01code_00_01table_00_01_record_00_01_primary_type_00_01void_01_4_1_1_primary_index.html" target="_self">PrimaryIndex</a></td><td class="desc"></td></tr>
+<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtable__impl.html" target="_self">table_impl</a></td><td class="desc"></td></tr>
+<tr id="row_10_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtable__impl_3_01sizeof_07uint128__t_08_00_01sizeof_07uint128__t_08_4.html" target="_self">table_impl&lt; sizeof(uint128_t), sizeof(uint128_t)&gt;</a></td><td class="desc"></td></tr>
+<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtable__impl_3_01sizeof_07uint64__t_08_00_010_01_4.html" target="_self">table_impl&lt; sizeof(uint64_t), 0 &gt;</a></td><td class="desc"></td></tr>
+<tr id="row_12_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_vote_action.html" target="_self">VoteAction</a></td><td class="desc"></td></tr>
+</table>
+</div><!-- directory -->
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>