Skip to content

Commit

Permalink
Updated Readme & Generated Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
bytemaster committed Sep 14, 2017
1 parent da5ce85 commit a2571c7
Show file tree
Hide file tree
Showing 336 changed files with 2,456 additions and 1,979 deletions.
402 changes: 208 additions & 194 deletions README.md

Large diffs are not rendered by default.

26 changes: 12 additions & 14 deletions contracts/eoslib/mainpage.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
Welcome to the EOS.io Documentation
Welcome to the EOS.IO Documentation
-----------------------------------

@note This documentation is in progress and subject to change due present rapid development. Please report inaccuracies identified to the [EOS developer telegram group](https://t.me/joinchat/EaEnSUPktgfoI-XPfMYtcQ)
@note This documentation is in progress and subject to change due present rapid development. Please report inaccuracies identified to the [EOS.IO Developer Telegram Group](https://t.me/joinchat/EaEnSUPktgfoI-XPfMYtcQ) and/or open an issue on

## EOS
## EOS.IO
- [EOS.IO Official Website](https://www.eos.io/)
- [Github](https://github.com/eosio)
- [Blog](https://steemit.com/@eosio)
- [Roadmap](https://github.com/EOSIO/Documentation/blob/master/Roadmap.md/)
- [Telegram](https://www.eos.io/chat/)
- [White Paper](https://github.com/EOSIO/Documentation/blob/master/TechnicalWhitePaper.md/)

## Building EOS
- [Environment Setup]()
## Building EOS.IO
- Environment Setup
- Automatic Build Script [Ubuntu 16.10](https://github.com/EOSIO/eos#autoubuntu) [macOS Sierra 10.12.6](https://github.com/EOSIO/eos#automac)
- Manual Build [Ubuntu 16.10](https://github.com/EOSIO/eos#ubuntu) [macOS Sierra 10.12.6](https://github.com/EOSIO/eos#macos)
- [Docker](https://github.com/EOSIO/eos/tree/master/Docker)
Expand All @@ -26,19 +27,16 @@ Welcome to the EOS.io Documentation
- [Getting Transaction](https://eosio.github.io/eos/group__eosc.html#gettingtransaction)

## Smart Contract Developers
- [Introduction](https://eosio.github.io/eos/group__contractdev.html)
- [Smart Contracts](https://github.com/EOSIO/eos#accountssmartcontracts)
- [Hello World ](https://eosio.github.io/eos/md_contracts_eoslib_tutorial.html)
- [Example Contracts](https://github.com/EOSIO/eos#example-smart-contracts)
- [Deploying Contracts](https://github.com/EOSIO/eos#upload-sample-contract-to-blockchain)
- [Benchmarking]()
- [Introduction to Contract Development Tutorial](https://eosio.github.io/eos/md_contracts_eoslib_tutorial.html)
- [Reference Introduction](https://eosio.github.io/eos/group__contractdev.html)
- [How to Deploy Example Smart Contracts](https://github.com/EOSIO/eos#accountssmartcontracts)
- [RPC Interface](https://eosio.github.io/eos/group__eosiorpc.html)
- API Reference
- @ref databaseapi - APIs that store and retreive data on the blockchainEOS.IO organizes data according to the following broad structure
- @ref contractdev
- @ref database - APIs that store and retreive data on the blockchainEOS.IO organizes data according to the following broad structure
- @ref mathapi - Defines common math function
- @ref messageapi - Define API for querying message properties
- @ref consoleapi - Enables applications to log/print text messages
- @ref tokens - Defines the ABI for interfacing with standard-compatible token messages and database tables
- @ref types - Specifies typedefs and aliases
- @ref transactionapi - Define API for sending transactions and inline messages
- @ref systemapi - Define API for interating with system level intrinsics
- @ref systemapi - Define API for interating with system level intrinsics
1 change: 1 addition & 0 deletions docs/_r_e_a_d_m_e_8md.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down
96 changes: 49 additions & 47 deletions docs/annotated.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/classeos_1_1_message-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down
31 changes: 16 additions & 15 deletions docs/classeos_1_1_message.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down Expand Up @@ -77,23 +78,23 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a10a37b405441dcb18c9172ed0b7a5849"><td class="memTemplParams" colspan="2">template&lt;typename Payload , typename ... Permissions&gt; </td></tr>
<tr class="memitem:a10a37b405441dcb18c9172ed0b7a5849"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a10a37b405441dcb18c9172ed0b7a5849">Message</a> (const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type, const Payload &amp;payload, Permissions... permissions)</td></tr>
<tr class="memitem:a10a37b405441dcb18c9172ed0b7a5849"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a10a37b405441dcb18c9172ed0b7a5849">Message</a> (const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type, const Payload &amp;payload, Permissions... permissions)</td></tr>
<tr class="separator:a10a37b405441dcb18c9172ed0b7a5849"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36ea35d105db634bd74ae7170bfc5297"><td class="memTemplParams" colspan="2">template&lt;typename Payload &gt; </td></tr>
<tr class="memitem:a36ea35d105db634bd74ae7170bfc5297"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a36ea35d105db634bd74ae7170bfc5297">Message</a> (const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type, const Payload &amp;payload)</td></tr>
<tr class="memitem:a36ea35d105db634bd74ae7170bfc5297"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a36ea35d105db634bd74ae7170bfc5297">Message</a> (const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type, const Payload &amp;payload)</td></tr>
<tr class="separator:a36ea35d105db634bd74ae7170bfc5297"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2858265f85675233cd4efbb934c4631a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a2858265f85675233cd4efbb934c4631a">Message</a> (const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type)</td></tr>
<tr class="memitem:a2858265f85675233cd4efbb934c4631a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a2858265f85675233cd4efbb934c4631a">Message</a> (const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;code, const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;type)</td></tr>
<tr class="separator:a2858265f85675233cd4efbb934c4631a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74eb5d1741b0ce6ac29161352d9565b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a74eb5d1741b0ce6ac29161352d9565b7">Message</a> (const <a class="el" href="classeos_1_1_message.html">Message</a> &amp;)=delete</td></tr>
<tr class="separator:a74eb5d1741b0ce6ac29161352d9565b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa05ef1b00fd732601bca906ff883b425"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#aa05ef1b00fd732601bca906ff883b425">Message</a> (<a class="el" href="classeos_1_1_message.html">Message</a> &amp;&amp;msg)</td></tr>
<tr class="separator:aa05ef1b00fd732601bca906ff883b425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce53f1a044eb929297efa1b566de74f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#abce53f1a044eb929297efa1b566de74f">~Message</a> ()</td></tr>
<tr class="separator:abce53f1a044eb929297efa1b566de74f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e68f632ec8aee71f4a8a909c8ed7c40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a0e68f632ec8aee71f4a8a909c8ed7c40">addPermissions</a> (<a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="el" href="types_8h.html#a4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission)</td></tr>
<tr class="memitem:a0e68f632ec8aee71f4a8a909c8ed7c40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a0e68f632ec8aee71f4a8a909c8ed7c40">addPermissions</a> (<a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission)</td></tr>
<tr class="separator:a0e68f632ec8aee71f4a8a909c8ed7c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7d568bb9c56b6d0824ee03c58c702fc"><td class="memTemplParams" colspan="2">template&lt;typename ... Permissions&gt; </td></tr>
<tr class="memitem:ae7d568bb9c56b6d0824ee03c58c702fc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#ae7d568bb9c56b6d0824ee03c58c702fc">addPermissions</a> (<a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="el" href="types_8h.html#a4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission, Permissions... permissions)</td></tr>
<tr class="memitem:ae7d568bb9c56b6d0824ee03c58c702fc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#ae7d568bb9c56b6d0824ee03c58c702fc">addPermissions</a> (<a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission, Permissions... permissions)</td></tr>
<tr class="separator:ae7d568bb9c56b6d0824ee03c58c702fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9caf8352a2fbfb71dbe5bc7774b18947"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_message.html#a9caf8352a2fbfb71dbe5bc7774b18947">send</a> ()</td></tr>
<tr class="separator:a9caf8352a2fbfb71dbe5bc7774b18947"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand All @@ -118,13 +119,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a10a37b405441dcb18c9172ed
<tr>
<td class="memname">eos::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
Expand Down Expand Up @@ -168,13 +169,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a36ea35d105db634bd74ae717
<tr>
<td class="memname">eos::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
Expand Down Expand Up @@ -210,13 +211,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2858265f85675233cd4efbb9
<tr>
<td class="memname">eos::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> &amp;&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="types_8h.html#a4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> &amp;&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
Expand Down Expand Up @@ -324,13 +325,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0e68f632ec8aee71f4a8a909
<tr>
<td class="memname">void eos::Message::addPermissions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramname"><em>account</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a>&#160;</td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a>&#160;</td>
<td class="paramname"><em>permission</em>&#160;</td>
</tr>
<tr>
Expand Down Expand Up @@ -362,13 +363,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae7d568bb9c56b6d0824ee03c
<tr>
<td class="memname">void eos::Message::addPermissions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramname"><em>account</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a>&#160;</td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a>&#160;</td>
<td class="paramname"><em>permission</em>, </td>
</tr>
<tr>
Expand Down
1 change: 1 addition & 0 deletions docs/classeos_1_1_transaction-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down
5 changes: 3 additions & 2 deletions docs/classeos_1_1_transaction.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down Expand Up @@ -83,7 +84,7 @@
<tr class="separator:a6e98939c13c55676c96103c751c58af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accc58f2a09d0e6acb9010f257821b46e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_transaction.html#accc58f2a09d0e6acb9010f257821b46e">~Transaction</a> ()</td></tr>
<tr class="separator:accc58f2a09d0e6acb9010f257821b46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a635d3c6c6c6dd64855c5ccc5daecb93c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_transaction.html#a635d3c6c6c6dd64855c5ccc5daecb93c">addScope</a> (<a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> scope, bool readOnly=false)</td></tr>
<tr class="memitem:a635d3c6c6c6dd64855c5ccc5daecb93c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_transaction.html#a635d3c6c6c6dd64855c5ccc5daecb93c">addScope</a> (<a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> scope, bool readOnly=false)</td></tr>
<tr class="separator:a635d3c6c6c6dd64855c5ccc5daecb93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a223c31ce9b4395d81a7ba8d882202d09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeos_1_1_transaction.html#a223c31ce9b4395d81a7ba8d882202d09">addMessage</a> (<a class="el" href="classeos_1_1_message.html">Message</a> &amp;message)</td></tr>
<tr class="separator:a223c31ce9b4395d81a7ba8d882202d09"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -234,7 +235,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a635d3c6c6c6dd64855c5ccc5
<tr>
<td class="memname">void eos::Transaction::addScope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
<td class="paramname"><em>scope</em>, </td>
</tr>
<tr>
Expand Down
1 change: 1 addition & 0 deletions docs/classeos_1_1iostream.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
&#160;<span id="projectnumber">DAWN1.0</span>
Expand Down
Loading

0 comments on commit a2571c7

Please sign in to comment.