From: brain Date: Thu, 18 Jan 2007 21:29:50 +0000 (+0000) Subject: A readme file, mainly for devs. X-Git-Tag: v2.0.23~5994 X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=a184aac0df7c864f3887024d3c56640e7034e7eb;p=user%2Fhenk%2Fcode%2Finspircd.git A readme file, mainly for devs. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@6392 e03df62e-2008-0410-955e-edbf42e46eb7 --- diff --git a/src/modules/m_spanningtree/README b/src/modules/m_spanningtree/README new file mode 100644 index 000000000..ff23e0381 --- /dev/null +++ b/src/modules/m_spanningtree/README @@ -0,0 +1,24 @@ +m_spanningtree +-------------- + +This directory contains all files required to build the m_spanningtree.so module. +Directories like this one starting with m_ and containing .cpp files are aggregated +together by the makefile to form a single .so, with the same name as the directory. + +This directory contains the following files: + +* handshaketimer.cpp Code for detecting end of ziplink/ssl handshake +* handshaketimer.h Header for above code +* link.h Contains the definition of the Link block class +* main.cpp The main group of classes and code for the module class +* main.h The header for the main file +* resolvers.h The header file that defines certain DNS utility classes +* treesocket.cpp Contains code that inherits InspSocket into a server socket +* treesocket.h Header definitions for above code +* treeserver.cpp Contains code that defines the behaviour of a single server +* treeserver.h Header definitions for above code +* utils.cpp Contains general and message routing utility classes +* utils.h Header code for general and message routing utilities + +Have fun + -- Brain :-)