Small comment change

2017-02-27 12:26:38 -05:00 · 2017-02-27 12:26:38 -05:00 · 0bbca7bc27
parent 7da26ca04d
commit 0bbca7bc27
1 changed files with 6 additions and 1 deletions
--- a/multiaddr.c
+++ b/multiaddr.c
@ -179,7 +179,12 @@ int multiaddress_encapsulate(struct MultiAddress* result, char* string)
 	return 1;
 }

-// not sure what this does
+/**
+ * Find scri and remove it from the resultant value
+ * (ie /ip4/127.0.0.1/tcp/4001 becomes ip4/127.0.0.1 when you call decapsulate(addr, "/tcp")
+ * @param result the address to work with
+ * @param srci the string to look for
+ */
 int multiaddress_decapsulate(struct MultiAddress * result, char * srci)
 {
 	if(result!=NULL && srci!=NULL)