Commits

Anonymous committed d3fe287

fix doxygen comments

  • Participants
  • Parent commits bb156bf

Comments (0)

Files changed (8)

File AthenaKernel/AddressProviderSvc.h

-/***************************************************************************
- helper class for ProxyProvider implementers
- -------------------------------------------
- ATLAS Collaboration
+/** @ class AddressProviderSvc 
+ * @brief helper class for ProxyProvider implementers
+ *
+ * @author ATLAS Collaboration
+ * $Id: AddressProviderSvc.h,v 1.2 2002-12-05 00:21:49 calaf Exp $
  ***************************************************************************/
 
-// $Id: AddressProviderSvc.h,v 1.1.1.1 2002-11-27 23:35:04 calaf Exp $
-
 #ifndef PROXYPROVIDER_ADDRESSPROVIDERSVC_H
 # define PROXYPROVIDER_ADDRESSPROVIDERSVC_H
 

File AthenaKernel/IAddressProvider.h

-/** interface for IOA providers
- ---------------------------
- ATLAS Collaboration
-
-/// $Id: IAddressProvider.h,v 1.2 2002-12-04 22:56:04 calaf Exp $
+/** @class IAddressProvider
+ * @brief interface for IOA providers
+ *
+ * @author <pcalafiura@lbl.gov> - ATLAS Collaboration
+ *
+ * $Id: IAddressProvider.h,v 1.3 2002-12-05 00:21:49 calaf Exp $
  ***************************************************************************/
 
 #ifndef ATHENAKERNEL_IADDRESSPROVIDER_H

File AthenaKernel/IAlgContextSvc.h

-/***************************************************************************
- create on demand proxies to be added to the proxy registry (DataStore)
- ----------------------------------------------------------------------
- ATLAS Collaboration
- ***************************************************************************/
-
-// $Id: IAlgContextSvc.h,v 1.2 2002-12-04 22:56:04 calaf Exp $
+/** @class IAlgContextSvc
+ * @brief create on demand proxies to be added to the proxy registry (DataStore) *
+ * $Id: IAlgContextSvc.h,v 1.3 2002-12-05 00:21:49 calaf Exp $
+ * @author ATLAS Collaboration
+ ***************************************************************************/ 
 
 #ifndef ATHENAKERNEL_IALGCONTEXTSVC_H
 # define ATHENAKERNEL_IALGCONTEXTSVC_H

File AthenaKernel/IAtRndmGenSvc.h

-/** manage multiple CLHEP random engines as named streams
-  * ---------------------------------------------------------------------
+/** @class IAtRndmGenSvc
+  * @brief manage multiple CLHEP random engines as named streams
+  * 
   * @author Giorgos Stavropoulos <George.Stavropoulos@cern.ch> 
   * @author Paolo Calafiura <pcalafiura@lbl.gov> 
+  * $Id: IAtRndmGenSvc.h,v 1.3 2002-12-05 00:21:49 calaf Exp $
   */
 
-// $Id: IAtRndmGenSvc.h,v 1.2 2002-12-04 22:56:04 calaf Exp $
-
 #ifndef ATHENAKERNEL_IATRNDMGENSVC_H
 # define ATHENAKERNEL_IATRNDMGENSVC_H
 

File AthenaKernel/IProxyProviderSvc.h

-/***************************************************************************
- add on demand proxies to the address registry (SG)
- ----------------------------------------------------------------------
- ATLAS Collaboration
+/** @class IProxyProviderSvc.h 
+ * @brief add on demand proxies to the address registry (SG)
+ *
+ * @author pcalafiura@lbl.gov - ATLAS Collaboration
  ***************************************************************************/
 
-// $Id: IProxyProviderSvc.h,v 1.2 2002-12-04 22:56:04 calaf Exp $
+// $Id: IProxyProviderSvc.h,v 1.3 2002-12-05 00:21:49 calaf Exp $
 
 #ifndef ATHENAKERNEL_IPROXYPROVIDERSVC_H
 # define ATHENAKERNEL_IPROXYPROVIDERSVC_H

File AthenaKernel/IProxyRegistry.h

-/** a proxy registry
- --------------------
- @author Paolo Calafiura - ATLAS
+/** @class IProxyRegistry   
+ * @brief a proxy registry
+ *
+ * @author Paolo Calafiura - ATLAS
+ *  $Id: IProxyRegistry.h,v 1.2 2002-12-05 00:21:49 calaf Exp $
  ***************************************************************************/
 
-// $Id: IProxyRegistry.h,v 1.1 2002-12-04 22:56:04 calaf Exp $
-
 #ifndef ATHENAKERNEL_IPROXYREGISTRY_H
 # define ATHENAKERNEL_IPROXYREGISTRY_H
 

File AthenaKernel/TransientID.h

-/** the transient (StoreGate) identifier of a dobj: the pair (CLID, key)
- --------------------------------------------------
- ATLAS Collaboration
+/** @class TransientID 
+ * @brief the transient (StoreGate) identifier of a dobj: the pair (CLID, key)
+ *
+ * @author pcalafiura@lbl.gov - ATLAS Collaboration
+ * $Id: TransientID.h,v 1.3 2002-12-05 00:21:49 calaf Exp $
  ***************************************************************************/
 
-// $Id: TransientID.h,v 1.2 2002-12-04 22:56:04 calaf Exp $
 
 #ifndef ATHENAKERNEL_TRANSIENTID_H
 # define ATHENAKERNEL_TRANSIENTID_H
   std::string m_key;
 };
 
-/** a STL predicate to compare TransientIDs to IOAs */
+/** @class CompareTransientIDToIOA 
+ * @brief   a STL predicate to compare TransientIDs to IOAs 
+ */
 class CompareTransientIDToIOA : public std::unary_function<IOpaqueAddress*, bool> {
 public:
   CompareTransientIDToIOA(const TransientID& id): m_id(id) {}

File cmt/requirements

 
 application TransientID_test -group=test -check ../test/TransientID_test.cxx
 
+private
+macro_append DOXYGEN_INPUT " ../doc ../test" 
+macro_append DOXYGEN_FILE_PATTERNS    " *.icc"