X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FLogger%2FAreaRegistry.hh;h=1ab88e601a2213db374d323fff4668a193fb7232;hb=5d4e096b18209cab72810f359e520dc8728f8e73;hp=8decd5559b61484b61eac252d1b7c25645a31aa3;hpb=f6f670f2dbc82b77db29df6cd452f2b351b9662a;p=senf.git diff --git a/Utils/Logger/AreaRegistry.hh b/Utils/Logger/AreaRegistry.hh index 8decd55..1ab88e6 100644 --- a/Utils/Logger/AreaRegistry.hh +++ b/Utils/Logger/AreaRegistry.hh @@ -1,8 +1,8 @@ // $Id$ // -// Copyright (C) 2007 -// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) -// Kompetenzzentrum fuer Satelitenkommunikation (SatCom) +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund // // This program is free software; you can redistribute it and/or modify @@ -43,11 +43,13 @@ namespace log { /** \brief Area registry - The area registry keeps track of all areas defined. Area classes are defined as singletons - and will automatically register with this registry. + The area registry keeps track of all areas defined. - The area registry exposes a forward sequence interface which is a sequence of the names of - all registered areas. + The area registry exposes a forward sequence interface which allows to query the list of all + registered areas. + + \implementation Area classes are defined as singletons and will automatically register with + this registry. */ class AreaRegistry : public senf::singleton @@ -62,6 +64,7 @@ namespace log { public: typedef boost::transform_iterator iterator; + ///< Iterator type # ifdef DOXYGEN // Hmm ... doxygen does not understand using declarations ... @@ -71,8 +74,8 @@ namespace log { using senf::singleton::instance; - iterator begin(); - iterator end(); + iterator begin(); ///< Beginning of area name sequence + iterator end(); ///< End of area name sequence private: AreaRegistry();