API Documentation

From RetroShare
Jump to: navigation, search

Documentation of the Retroshare API is paramount to it being used by other App developers as a network layer and ftf/web-of-trust library. The API is quite well structured, but it would be additionally useful to have an API document to lookup when in doubt. 9 done, 139 to go!


Doxy-gen also provides clear interaction diagrams for those not sure whats going on with certain objects in libretroshare. See here for an example on how to comment on code modules (classes and their functions).

  • dbase/cachestrapper.h --Chris parker126 15:59, 10 July 2010 (UTC)
  • dbase/cachetest.h
  • dbase/fimonitor.h
  • dbase/findex.h
  • dbase/fistore.h
  • dht/b64.h
  • dht/dhtclient.h
  • dht/dhthandler.h
  • dht/opendht.h
  • dht/opendhtmgr.h
  • dht/opendhtstr.h
  • ft/ftchunkmap.h
  • ft/ftcontroller.h
  • ft/ftdata.h
  • ft/ftdatamultiplex.h
  • ft/ftdbase.h
  • ft/ftdwlqueue.h
  • ft/ftextralist.h
  • ft/ftfilecreator.h
  • ft/ftfileprovider.h
  • ft/ftfilesearch.h
  • ft/ftsearch.h
  • ft/ftserver.h
  • ft/fttransfermodule.h
  • ft/pqitestor.h
  • pqi/authgpg.h
  • pqi/authssl.h
  • pqi/cleanupxpgp.h
  • pqi/p3cfgmgr.h --Chris parker126 11:48, 15 April 2010 (UTC)
  • pqi/p3connmgr.h
  • pqi/p3dhtmgr.h
  • pqi/p3notify.h
  • pqi/p3upnpmgr.h
  • pqi/pqiarchive.h
  • pqi/pqiassist.h
  • pqi/pqi_base.h --Chris parker126 11:48, 15 April 2010 (UTC)
  • pqi/pqibin.h --Chris parker126 11:48, 15 April 2010 (UTC)
  • pqi/pqi.h
  • pqi/pqihandler.h
  • pqi/pqihash.h
  • pqi/pqiindic.h
  • pqi/pqilistener.h
  • pqi/pqiloopback.h
  • pqi/pqimonitor.h
  • pqi/pqinetwork.h
  • pqi/pqinotify.h
  • pqi/pqipersongrp.h
  • pqi/pqiperson.h
  • pqi/pqisecurity.h
  • pqi/pqiservice.h
  • pqi/pqissl.h
  • pqi/pqissllistener.h
  • pqi/pqisslpersongrp.h
  • pqi/pqissltunnel.h
  • pqi/pqissludp.h
  • pqi/pqistore.h
  • pqi/pqistreamer.h
  • pqi/sslcert.h
  • pqi/xpgpcert.h
  • rsiface/rsblogs.h
  • rsiface/rschannels.h
  • rsiface/rsdisc.h
  • rsiface/rsdistrib.h
  • rsiface/rsexpr.h
  • rsiface/rsfiles.h
  • rsiface/rsforums.h
  • rsiface/rsgame.h
  • rsiface/rsiface.h
  • rsiface/rsinit.h
  • rsiface/rsmsgs.h
  • rsiface/rsnotify.h
  • rsiface/rspeers.h
  • rsiface/rsphoto.h
  • rsiface/rsQblog.h
  • rsiface/rsrank.h
  • rsiface/rsstatus.h --Chris parker126 15:34, 16 April 2010 (UTC)
  • rsiface/rsturtle.h
  • rsiface/rstypes.h
  • rsserver/p3blog.h
  • rsserver/p3discovery.h
  • rsserver/p3face.h
  • rsserver/p3msgs.h --Chris parker126 11:55, 27 April 2010 (UTC)
  • rsserver/p3peers.h
  • rsserver/p3photo.h
  • rsserver/p3rank.h
  • serialiser/rsbaseitems.h
  • serialiser/rsbaseserial.h
  • serialiser/rsblogitems.h
  • serialiser/rschannelitems.h
  • serialiser/rsconfigitems.h
  • serialiser/rsdiscitems.h
  • serialiser/rsdistribitems.h
  • serialiser/rsforumitems.h
  • serialiser/rsgameitems.h
  • serialiser/rsmsgitems.h
  • serialiser/rsphotoitems.h
  • serialiser/rsqblogitems.h
  • serialiser/rsrankitems.h
  • serialiser/rsserial.h
  • serialiser/rsserviceids.h
  • serialiser/rsserviceitems.h
  • serialiser/rsstatusitems.h
  • serialiser/rstlvbase.h
  • serialiser/rstlvkeys.h
  • serialiser/rstlvkvwide.h
  • serialiser/rstlvtypes.h
  • serialiser/rstlvutil.h
  • serialiser/rstunnelitems.h
  • services/p3blogs.h
  • services/p3channels.h
  • services/p3chatservice.h --Chris parker126 11:26, 24 April 2010 (UTC)
  • services/p3disc.h
  • services/p3distrib.h --Chris parker126 11:48, 15 April 2010 (UTC)
  • services/p3forums.h
  • services/p3gamelauncher.h
  • services/p3gameservice.h
  • services/p3msgservice.h
  • services/p3photoservice.h
  • services/p3portservice.h
  • services/p3Qblog.h
  • services/p3ranking.h
  • services/p3service.h
  • services/p3status.h --Chris parker126 15:34, 16 April 2010 (UTC)
  • services/p3tunnel.h
  • tcponudp/bio_tou.h
  • tcponudp/extaddrfinder.h
  • tcponudp/tcppacket.h
  • tcponudp/tcpstream.h
  • tcponudp/tou_errno.h
  • tcponudp/tou.h
  • tcponudp/tou_net.h
  • tcponudp/udplayer.h
  • tcponudp/udpsorter.h
  • tcponudp/udptestfn.h
  • turtle/p3turtle.h
  • turtle/rsturtleitem.h
  • turtle/turtletypes.h
  • upnp/UPnPBase.h
  • upnp/upnphandler.h
  • upnp/upnputil.h
  • util/rsdebug.h
  • util/rsdir.h
  • util/rsnet.h
  • util/rsprint.h
  • util/rsthreads.h
  • util/rsversion.h
  • util/rswin.h
  • util/utest.h
Personal tools
Namespaces

Variants
Actions
Navigation
External websites
Wiki
Toolbox