status-im
/
go-libp2p-pubsub
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #147 from libp2p/documentation 

godoc is not html either
This commit is contained in:
vyzo 2019-01-11 12:32:06 +02:00 committed by GitHub
parent b9204320ce 153c9f77c7
commit 2e1fb613f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc.go
View File

@ -4,11 +4,12 @@
//
// The main interface to the library is the PubSub object.
// You can construct this object with the following constructors:
// <ul>
// <li> NewFloodSub creates an instance that uses the floodsub routing algorithm. </li>
// <li> NewGossipSub creates an instance that uses the gossipsub routing algorithm. </li>
// <li> NewRandomSub creates an instance that uses the randomsub routing algorithm. </li>
// </ul>
//
// - NewFloodSub creates an instance that uses the floodsub routing algorithm.
//
// - NewGossipSub creates an instance that uses the gossipsub routing algorithm.
//
// - NewRandomSub creates an instance that uses the randomsub routing algorithm.
//
// In addition, there is a generic constructor that creates a pubsub instance with
// a custom PubSubRouter interface. This procedure is currently reserved for internal