Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

DAWN-140 ⁃ p2p network protocol documentation #181

Closed
pmesnier opened this issue Aug 16, 2017 · 8 comments
Closed

DAWN-140 ⁃ p2p network protocol documentation #181

pmesnier opened this issue Aug 16, 2017 · 8 comments
Assignees
@pmesnier
Labels
documentation Requires attention from documentation team. e.g. documentation is expected to be generated.
Milestone
Backlog

Comments

@pmesnier
Copy link
Contributor

pmesnier commented Aug 16, 2017 •
edited by blockone-syncclient
Loading

Need to add doxygen formatted comments to all of the net plugin headers
@pmesnier pmesnier self-assigned this Aug 16, 2017
@pmesnier pmesnier added documentation Requires attention from documentation team. e.g. documentation is expected to be generated. in progress labels Aug 29, 2017
@pmesnier
Copy link
Contributor Author

Adding Doxygen style comments to the net_plugin headers.

@pmesnier
Copy link
Contributor Author

Work still in progress. I should be able to commit later tonight or tomorrow.

@pmesnier pmesnier added this to the EOS Dawn 2.0 milestone Sep 13, 2017
@pmesnier
Copy link
Contributor Author

still valid, but pushing to milestone 2

@blockone-syncclient blockone-syncclient changed the title p2p network protocol documentation STAT-140 ⁃ p2p network protocol documentation Nov 7, 2017
@heifner heifner modified the milestones: EOS Dawn 2.0, EOS Dawn 3.0 Dec 4, 2017
@blockone-syncclient blockone-syncclient changed the title STAT-140 ⁃ p2p network protocol documentation DAWN-140 ⁃ p2p network protocol documentation Jan 16, 2018
@blockone-syncclient
Copy link

➤ Phil Mesnier commented:

I've been addressing the two big "winnebago" classes in net_plugin.cpp, net_plugin_impl and connection, by breaking the classes into chains of specialization. This means that instead of a single class with 80 methods, I have 8 classes with an average of 10 methods each, where these are all logically related. In the end the final class contains all of methods, but in bite-sized chunks.

I am also documenting the theory of operation - including state transitions. This work isn't done yet, but I am setting it aside for now. I'll have to complete it later.

@coreylederer coreylederer modified the milestones: Q1, 2018, RC1 Mar 22, 2018
@bytemaster bytemaster modified the milestones: RC1, RC2 Mar 22, 2018
@gleehokie gleehokie modified the milestones: RC2, Backlog Apr 6, 2018
@andriantolie
Copy link
Contributor

@pmesnier are we still working at this?

@pmesnier
Copy link
Contributor Author

Certainly! It is low priority, but given the multitude of roles filled by the main classes I think it is important enough to pursue. Now that the mainnet is live I think a prudent course of action is to provide documentation for groups of functions without actually modifying running code. That will come later.

@andriantolie
Copy link
Contributor

Great. I won't close this issue then. Thanks for the reply!

ljrprocc pushed a commit to bithacks-tech/myeosio that referenced this issue Jul 4, 2018
Merge pull request EOSIO#181 from enumivo/tokentomaster
f7f1f8e 
update contstitution
@brianjohnson5972
Copy link
Contributor

@wanderingbort or @heifner I think the answer to this now is that it won't be done, do you agree?

NorseGaud pushed a commit that referenced this issue Jul 30, 2019
# This is a combination of 186 commits.
6c09577 
# This is the 1st commit message:

various improvements

# This is the commit message #2:

new hash

# This is the commit message #3:

fix for script path

# This is the commit message #4:

fixes

# This is the commit message #5:

fixes

# This is the commit message #6:

fixes

# This is the commit message #7:

fixes

# This is the commit message #8:

fixes

# This is the commit message #9:

fixes

# This is the commit message #10:

fixes

# This is the commit message #11:

fixes

# This is the commit message #12:

fixes

# This is the commit message #13:

fixes

# This is the commit message #14:

fixes

# This is the commit message #15:

fixes

# This is the commit message #16:

fixes

# This is the commit message #17:

fixes

# This is the commit message #18:

fixes

# This is the commit message #19:

fixes

# This is the commit message #20:

fixes

# This is the commit message #21:

fixes

# This is the commit message #22:

fixes

# This is the commit message #23:

fixes

# This is the commit message #24:

fixes

# This is the commit message #25:

fixes

# This is the commit message #26:

testing

# This is the commit message #27:

testing

# This is the commit message #28:

testing

# This is the commit message #29:

testing

# This is the commit message #30:

testing

# This is the commit message #31:

testing

# This is the commit message #32:

testing

# This is the commit message #33:

testing

# This is the commit message #34:

testing

# This is the commit message #35:

testing

# This is the commit message #36:

testing

# This is the commit message #37:

testing

# This is the commit message #38:

testing

# This is the commit message #39:

testing

# This is the commit message #40:

testing

# This is the commit message #41:

testing

# This is the commit message #42:

testing

# This is the commit message #43:

testing

# This is the commit message #44:

fixes

# This is the commit message #45:

fixes

# This is the commit message #46:

fixes

# This is the commit message #47:

fixes

# This is the commit message #48:

fixes

# This is the commit message #49:

fixes

# This is the commit message #50:

fixes

# This is the commit message #51:

fixes

# This is the commit message #52:

fixes

# This is the commit message #53:

fixes

# This is the commit message #54:

fixes

# This is the commit message #55:

fixes

# This is the commit message #56:

fixes

# This is the commit message #57:

fixes

# This is the commit message #58:

fixes

# This is the commit message #59:

fixes

# This is the commit message #60:

fixes

# This is the commit message #61:

fixes

# This is the commit message #62:

fixes

# This is the commit message #63:

fixes

# This is the commit message #64:

fixes

# This is the commit message #65:

fixes

# This is the commit message #66:

fixes

# This is the commit message #67:

fixes

# This is the commit message #68:

fixes

# This is the commit message #69:

fixes

# This is the commit message #70:

fixes

# This is the commit message #71:

fixes

# This is the commit message #72:

fixes

# This is the commit message #73:

fixes

# This is the commit message #74:

fixes

# This is the commit message #75:

fixes

# This is the commit message #76:

fixes

# This is the commit message #77:

fixes

# This is the commit message #78:

fixes

# This is the commit message #79:

more testing

# This is the commit message #80:

testing

# This is the commit message #81:

fixes

# This is the commit message #82:

fixes

# This is the commit message #83:

fixes

# This is the commit message #84:

fixes

# This is the commit message #85:

fixes

# This is the commit message #86:

fixes

# This is the commit message #87:

fixes

# This is the commit message #88:

fixes

# This is the commit message #89:

fixes

# This is the commit message #90:

fixes

# This is the commit message #91:

fixes

# This is the commit message #92:

fixes

# This is the commit message #93:

propagate-environment for buildkite-agent

# This is the commit message #94:

propagate-environment for buildkite-agent

# This is the commit message #95:

propagate-environment for buildkite-agent

# This is the commit message #96:

propagate-environment for buildkite-agent

# This is the commit message #97:

fixes

# This is the commit message #98:

fixes

# This is the commit message #99:

fixes

# This is the commit message #100:

fixes

# This is the commit message #101:

fixes

# This is the commit message #102:

fixes

# This is the commit message #103:

fixes

# This is the commit message #104:

fixes

# This is the commit message #105:

fixes

# This is the commit message #106:

fixes

# This is the commit message #107:

fixes

# This is the commit message #108:

fixes

# This is the commit message #109:

fixes

# This is the commit message #110:

fixes

# This is the commit message #111:

fixes

# This is the commit message #112:

fixes

# This is the commit message #113:

fixes

# This is the commit message #114:

fixes

# This is the commit message #115:

fixes

# This is the commit message #116:

fixes

# This is the commit message #117:

fixes

# This is the commit message #118:

fixes

# This is the commit message #119:

fixes

# This is the commit message #120:

fixes

# This is the commit message #121:

fixes

# This is the commit message #122:

fixes

# This is the commit message #123:

fixes

# This is the commit message #124:

fixes

# This is the commit message #125:

fixes

# This is the commit message #126:

fixes

# This is the commit message #127:

fixes

# This is the commit message #128:

fixes

# This is the commit message #129:

fixes

# This is the commit message #130:

fixes

# This is the commit message #131:

fixes

# This is the commit message #132:

fixes

# This is the commit message #133:

fixes

# This is the commit message #134:

fixes

# This is the commit message #135:

fixes

# This is the commit message #136:

fixes

# This is the commit message #137:

fixes

# This is the commit message #138:

fixes

# This is the commit message #139:

fixes

# This is the commit message #140:

fixes

# This is the commit message #141:

fixes

# This is the commit message #142:

fixes

# This is the commit message #143:

fixes

# This is the commit message #144:

fixes

# This is the commit message #145:

fixes

# This is the commit message #146:

fixes

# This is the commit message #147:

fixes

# This is the commit message #148:

fixes

# This is the commit message #149:

fixes

# This is the commit message #150:

fixes

# This is the commit message #151:

fixes

# This is the commit message #152:

fixes

# This is the commit message #153:

testing

# This is the commit message #154:

fixes

# This is the commit message #155:

fixes

# This is the commit message #156:

fixes

# This is the commit message #157:

fixes

# This is the commit message #158:

fixes

# This is the commit message #159:

fixes

# This is the commit message #160:

fixes

# This is the commit message #161:

fixes

# This is the commit message #162:

fixes

# This is the commit message #163:

fixes

# This is the commit message #164:

fixes

# This is the commit message #165:

fixes

# This is the commit message #166:

fixes

# This is the commit message #167:

fixes

# This is the commit message #168:

fixes

# This is the commit message #169:

fixes

# This is the commit message #170:

fixes

# This is the commit message #171:

fixes

# This is the commit message #172:

fixes

# This is the commit message #173:

fixes

# This is the commit message #174:

fixes

# This is the commit message #175:

fixes

# This is the commit message #176:

fixes

# This is the commit message #177:

fixes

# This is the commit message #178:

fixes

# This is the commit message #179:

fixes

# This is the commit message #180:

fixes

# This is the commit message #181:

fixes

# This is the commit message #182:

fixes

# This is the commit message #183:

fixes

# This is the commit message #184:

fixes

# This is the commit message #185:

fixes

# This is the commit message #186:

fixes
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@pmesnier pmesnier

Labels
documentation Requires attention from documentation team. e.g. documentation is expected to be generated.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
8 participants
@bytemaster @gleehokie @pmesnier @heifner @andriantolie @brianjohnson5972 @coreylederer @blockone-syncclient