From: g0dil Date: Fri, 20 Jul 2007 10:50:02 +0000 (+0000) Subject: Socket: Add additional policy-dependency documentation to ClientSocketHandle X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=5457377c2eda70c535303f6cf87413bbb51bf1ea;p=senf.git Socket: Add additional policy-dependency documentation to ClientSocketHandle Correcly handle documentation in subdirectories git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@328 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Packets/DefaultBundle/Doxyfile b/Packets/DefaultBundle/Doxyfile index 2e8aec2..c221a91 100644 --- a/Packets/DefaultBundle/Doxyfile +++ b/Packets/DefaultBundle/Doxyfile @@ -1,6 +1,6 @@ @INCLUDE = "$(TOPDIR)/doclib/Doxyfile.global" -PROJECT_NAME = libPackets/DefaultBundle +PROJECT_NAME = DefaultBundle TAGFILES = "$(TOPDIR)/Utils/doc/Utils.tag" "$(TOPDIR)/Packets/doc/Packets.tag" GENERATE_TAGFILE = doc/DefaultBundle.tag INPUT = . diff --git a/Packets/Doxyfile b/Packets/Doxyfile index 931a153..b9e5c08 100644 --- a/Packets/Doxyfile +++ b/Packets/Doxyfile @@ -3,7 +3,6 @@ PROJECT_NAME = libPackets TAGFILES = "$(TOPDIR)/Utils/doc/Utils.tag" GENERATE_TAGFILE = doc/Packets.tag -#INPUT = . DefaultBundle MPEG_DVBBundle INPUT = . -#EXAMPLE_PATH = . DefaultBundle +EXAMPLE_PATH = . DefaultBundle diff --git a/Packets/MPEGDVBBundle/Doxyfile b/Packets/MPEGDVBBundle/Doxyfile index 9e3a960..db2a469 100644 --- a/Packets/MPEGDVBBundle/Doxyfile +++ b/Packets/MPEGDVBBundle/Doxyfile @@ -1,6 +1,6 @@ @INCLUDE = "$(TOPDIR)/doclib/Doxyfile.global" -PROJECT_NAME = libPackets/MPEGDVBBundle +PROJECT_NAME = MPEGDVBBundle TAGFILES = "$(TOPDIR)/Utils/doc/Utils.tag" "$(TOPDIR)/Packets/doc/Packets.tag" GENERATE_TAGFILE = doc/MPEGDVBBundle.tag INPUT = . diff --git a/Socket/ClientSocketHandle.hh b/Socket/ClientSocketHandle.hh index 2b6f425..07f2069 100644 --- a/Socket/ClientSocketHandle.hh +++ b/Socket/ClientSocketHandle.hh @@ -46,20 +46,23 @@ namespace senf { This class provides the client side policy interface of the socket abstraction. ClientSocketHandle defines the complete policy interface. It does not implement - any functionality itself however. All calls are forward to the following policy classes: + any functionality itself however. The following table shows, to which policy members each + group of ClientSocketHandle members is forwardd. The last collumn shows, on which other + policies this member-group depends in the default policy classes. If you define + your own policy classes, the dependencies are up to you. - - - - - - - - - - - + + + + + + + + + + +
ClientSocketHandle member Policy member
read() ReadPolicy::read (\ref senf::ReadPolicyBase)
readfrom() ReadPolicy::readfrom (\ref senf::ReadPolicyBase)
write() WritePolicy::write (\ref senf::WritePolicyBase)
writeto() WritePolicy::writeto (\ref senf::WritePolicyBase)
connect() AddressingPolicy::connect (\ref senf::AddressingPolicyBase)
bind() AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
peer() AddressingPolicy::peer (\ref senf::AddressingPolicyBase)
local() AddressingPolicy::local (\ref senf::AddressingPolicyBase)
rcvbuf() BufferingPolicy::sndbuf (\ref senf::BufferingPolicyBase)
sndbuf() BufferingPolicy::rcvbuf (\ref senf::BufferingPolicyBase)
ClientSocketHandle member Policy member Other policies
read() ReadPolicy::read (\ref senf::ReadPolicyBase)
readfrom() ReadPolicy::readfrom (\ref senf::ReadPolicyBase) UnconnectedCommunicationPolicy
write() WritePolicy::write (\ref senf::WritePolicyBase) ConnectedCommunicationPolicy
writeto() WritePolicy::writeto (\ref senf::WritePolicyBase) UnconnectedCommunicationPolicy
connect() AddressingPolicy::connect (\ref senf::AddressingPolicyBase)
bind() AddressingPolicy::bind (\ref senf::AddressingPolicyBase)
peer() AddressingPolicy::peer (\ref senf::AddressingPolicyBase)
local() AddressingPolicy::local (\ref senf::AddressingPolicyBase)
rcvbuf() BufferingPolicy::sndbuf (\ref senf::BufferingPolicyBase)
sndbuf() BufferingPolicy::rcvbuf (\ref senf::BufferingPolicyBase)
It is important to note, that not all members are always accessible. Which are depends on diff --git a/doclib/SConscript b/doclib/SConscript index 61b7eba..e72656b 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -8,16 +8,37 @@ import SENFSCons import yaptu def modules(): + # Naja ... etwas rumgehackt aber was solls ... global EXTRA_MODULES - rv = [] + mods = {} ix = len(env.Dir('#').abspath)+1 ex = dict((env.Dir(p).abspath,True) for n,p in EXTRA_MODULES) for module in env.Alias('all_docs')[0].sources: if module.name != 'html.stamp' : continue if not ex.get(module.dir.abspath): - rv.append(('lib%s' % module.dir.dir.dir.name, module.dir.abspath[ix:])) - rv.sort() - return [ (name, env.Dir(path).abspath[ix:]) for name,path in EXTRA_MODULES ] + rv + mods[module.dir.dir.dir.abspath] = [ module.dir.dir.dir.name, module.dir.abspath[ix:], 0 ] + rv = [] + keys = mods.keys() + keys.sort() + for mod in keys: + i = 0 + while i < len(rv): + if mod.startswith(rv[i] + '/'): + level = mods[rv[i]][2] + 1 + i += 1 + while i < len(rv) and mods[rv[i]][2] >= level: + i += 1 + rv[i:i] = [ mod ] + mods[mod][2] = level + break + i += 1 + if i == len(rv): + rv.append(mod) + return [ (name, env.Dir(path).abspath[ix:], 0) for name,path in EXTRA_MODULES + ] + [ ( (((not mods[mod][2]) and 'lib') or '') + mods[mod][0], + mods[mod][1], + mods[mod][2]) + for mod in rv ] def indices(): ix = len(env.Dir('#').abspath)+1 @@ -79,8 +100,8 @@ div.tabs ul li.$projectname a { background-color: #EDE497; }
    -{{ for name, path in modules(): -
  • ${name}
    • +{{ for name, path, level in modules(): +
  • ${name}
    • }}
""" diff --git a/doclib/senf.css b/doclib/senf.css index 4263f8f..2df0ed6 100644 --- a/doclib/senf.css +++ b/doclib/senf.css @@ -190,6 +190,11 @@ div.tabs ul li a:hover, div.tabs ul li.current a { background-color: #EDE497; } +div.tabs ul li.level1 a { + padding-left: 2em; + font-size: 90%; +} + #footer { clear: both; padding: 4px 10px 4px 142px;