Commits

Anonymous committed 7201649

doc standdown

Comments (0)

Files changed (8)

 
 apply_pattern UnitTest_run unit_test=SGFolder
 
+macro_append DOXYGEN_INPUT " ../test " 
+/**
+
+   @mainpage  
+
+contains the Gaudi components implementing StoreGate.
+
+@htmlinclude used_packages.html
+
+@section test Unit Tests
+
+ - ProxyProviderSvc_test.cxx
+ - SGFolder_test.cxx
+
+@section reqs CMT requirements file
+
+@include requirements
+
+@section refs More Documentation
+
+More information is available from the Athena wiki 
+(https://twiki.cern.ch/twiki/bin/view/Atlas/AthenaFramework#StoreGate_The_Data_Model_Archite)
+
+The code can be browsed using LXR 
+(http://alxr.usatlas.bnl.gov/lxr/source/atlas/Control/SGComps/)
+
+
+@author Paolo Calafiura <Paolo.Calafiura@cern.ch>
+
+*/

src/ProxyProviderSvc.cxx

 				   ISvcLocator* svcLoc): 
   Service(name, svcLoc) 
 {
-  declareProperty("ProviderNames", m_providerNames);
+  declareProperty("ProviderNames", m_providerNames,
+		  "names of the services to be use as address providers");
   m_providerNames.declareUpdateHandler(&ProxyProviderSvc::providerNamesPropertyHandler, this);
 }
 

src/ProxyProviderSvc.h

-/** manages the address providers and add proxies on demand to the store
-  * ---------------------------------------------------------------------
+/** @file ProxyProviderSvc.h
+    @brief manages the address providers and add proxies on demand to the store
   * @author Paolo Calafiura <pcalafiura@lbl.gov> - ATLAS Collaboration
+  * $Id: ProxyProviderSvc.h,v 1.2 2007-06-22 23:54:56 calaf Exp $
   */
 
-// $Id: ProxyProviderSvc.h,v 1.1.1.1 2007-06-22 23:21:47 calaf Exp $
 
 #ifndef STOREGATE_PROXYPROVIDERSVC_H
 # define STOREGATE_PROXYPROVIDERSVC_H
 
-//<<<<<< INCLUDES                                                       >>>>>>
 #ifndef ATHENAKERNEL_IPROXYPROVIDERSVC_H
  #include "AthenaKernel/IProxyProviderSvc.h"
 #endif
 #ifndef _CPP_STRING
  #include <string>
 #endif
-//<<<<<< PUBLIC DEFINES                                                 >>>>>>
-//<<<<<< PUBLIC CONSTANTS                                               >>>>>>
-//<<<<<< PUBLIC FUNCTIONS                                               >>>>>>
-//<<<<<< FORWARD DECLARATIONS                                           >>>>>>
 namespace SG {
   class DataProxy;
   class TransientAddress;
 class ISvcLocator;
 template <class TYPE> class SvcFactory;
 
-//<<<<<< CLASS DECLARATIONS                                             >>>>>>
-
+///manages the address providers and add proxies on demand to the store
 class ProxyProviderSvc : virtual public IProxyProviderSvc,
 			 public Service 
 {
   virtual ~ProxyProviderSvc();
 
 private:
-  /// the services declared as providers
+  /// property: the services declared as providers
   StringArrayProperty m_providerNames;
   /// the handler for m_providerNames
   void providerNamesPropertyHandler( Property& theProp );
 };
 
 
-//<<<<<< INLINE PUBLIC FUNCTIONS                                        >>>>>>
-//<<<<<< INLINE MEMBER FUNCTIONS                                        >>>>>>
 inline void ProxyProviderSvc::addProvider(IAddressProvider* aProvider) {
   assert(aProvider);
   m_providers.insert(aProvider);
 		const IInterface* parent) : 
   AlgTool( type, name, parent ), m_pCLIDSvc("ClassIDSvc", name)
 {
-  declareProperty("ItemList", m_itemList).ignore();
+  declareProperty("ItemList", m_itemList,
+		  " list of data objects identified by a class name (or clid)#key pairs. One can use '*' as key value to add all objects of a given type to the Folder ").ignore();
   m_itemList.declareUpdateHandler(&Folder::decodeItemList, this);
 }
 
 #ifndef SGTOOLS_FOLDER_H
 #define SGTOOLS_FOLDER_H
+  /** @file SGFolder.h
+   * @brief a run-time configurable list of data objects
+   *
+   * @author pcalafiura@lbl.gov - ATLAS Collaboration
+   * $Id: SGFolder.h,v 1.2 2007-06-22 23:54:59 calaf Exp $
+   **/
 
 #include <string>
 
 
 namespace SG {
 
-  /** @class SG::Folder
+  /** @class Folder
    * @brief a run-time configurable list of data objects
-   *
-   * @author pcalafiura@lbl.gov - ATLAS Collaboration
-   * $Id: SGFolder.h,v 1.1.1.1 2007-06-22 23:21:48 calaf Exp $
+   * @details the ItemList property, used to initialize the folder, is a
+   * list of class name (or clid)/key pairs.
+   * One can use '*' as key value to add all objects of a given type 
+   * to the Folder.
+   * Examples:
+   @code
+    ItemList = [ "DataHeader#*", "AthenaAttributeList#SimpleTag", "8101/Foo" ]
+   @endcode
    **/
   class Folder : public virtual IFolder, public virtual AlgTool
   {
 
   private:
     ServiceHandle<IClassIDSvc> m_pCLIDSvc;
+    /// property: the list of items (data objects identified by a class name/key pair)
     StringArrayProperty m_itemList;
     void decodeItemList(Property&);
     void decodeItem(std::string); //FIXME

test/ProxyProviderSvc_test.cxx

-/***************************************************************************
- unit test for the proxy provide mechanism
- -----------------------------------------
- ATLAS Collaboration
+/** @file ProxyProviderSvc_test.cxx
+ * @brief unit test for the proxy provider mechanism
+ * @author ATLAS Collaboration
  ***************************************************************************/
 
-// $Id: ProxyProviderSvc_test.cxx,v 1.1.1.1 2007-06-22 23:21:48 calaf Exp $
+// $Id: ProxyProviderSvc_test.cxx,v 1.2 2007-06-22 23:54:59 calaf Exp $
 
 //<<<<<< INCLUDES                                                       >>>>>>
 

test/SGFolder_test.cxx

+/** @file SGFolder_test.cxx
+ * @brief unit test for SG::Folder
+ * @author ATLAS Collaboration
+ */
 #undef NDEBUG
 
 #include <algorithm>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.