]> git.uio.no Git - u/mrichter/AliRoot.git/commitdiff
Fixing in/out tags in documentation
authoraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 11 Jul 2011 22:07:52 +0000 (22:07 +0000)
committeraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 11 Jul 2011 22:07:52 +0000 (22:07 +0000)
HLT/TPCLib/AliHLTTPCAgent.h
HLT/TPCLib/AliHLTTPCDefinitions.h
HLT/TPCLib/calibration/AliHLTTPCCalibrationAgent.h
HLT/TPCLib/comp/AliHLTTPCCompModelConverter.h
HLT/TPCLib/offline/AliHLTTPCDigitPublisherComponent.h

index d40d5c4ff9ba9c5b73655c096c6b2cdca9764dba..7bb1f3edf841a02b79e592302ef200cf8b403501 100644 (file)
@@ -69,15 +69,15 @@ class AliHLTTPCAgent : public AliHLTModuleAgent {
 
   /**
    * Register components for the AliHLTTPC library.
-   * @param pHandler  [in] instance of the component handler          
+   * @param [in] pHandler  instance of the component handler          
    */
   int RegisterComponents(AliHLTComponentHandler* pHandler) const;
 
   /**
    * Get handler decription for TPC data in the HLTOUT data stream.
-   * @param dt        [in] data type of the block
-   * @param spec      [in] specification of the block
-   * @param desc      [out] handler description
+   * @param [in]  dt        data type of the block
+   * @param [in]  spec      specification of the block
+   * @param [out] desc      handler description
    * @return 1 if the agent can provide a handler, 0 if not
    */
   int GetHandlerDescription(AliHLTComponentDataType dt,
@@ -86,8 +86,8 @@ class AliHLTTPCAgent : public AliHLTModuleAgent {
 
   /**
    * Get specific handler for TPC data in the HLTOUT data stream.
-   * @param dt        [in] data type of the block
-   * @param spec      [in] specification of the block
+   * @param [in] dt        data type of the block
+   * @param [in] spec      specification of the block
    * @return pointer to handler
    */
   AliHLTOUTHandler* GetOutputHandler(AliHLTComponentDataType dt,
index f5b97eb0de0fbdf48130f0d53d6badbbcf8fcf6a..177364a4c933fa6948337c488f2e6f116d4aceaa 100644 (file)
@@ -77,9 +77,9 @@ public:
                
        /**
         * Converts a DDL ID number for the TPC to a slice and patch number.
-        * [in] \param ddlid  The DDL ID number to convert.
-        * [out] \param slice  The resultant slice number in the range [0..35].
-        * [out] \param patch  The resultant patch number in the range [0..5].
+        * \param [in] ddlid  The DDL ID number to convert.
+        * \param [out] slice  The resultant slice number in the range [0..35].
+        * \param [out] patch  The resultant patch number in the range [0..5].
         * \returns true if the DDL ID number was valid and slice and patch were set,
         *     otherwise false for an invalid DDL ID.
         */
index 68b548093a9a75233e8495321b10f071102e6a81..e345b679ab050d837d2f458c2d3db89b430bb40f 100644 (file)
@@ -54,9 +54,9 @@ class AliHLTTPCCalibrationAgent : public AliHLTModuleAgent {
    * AliHLTConfigurationHandler. The agent can adapt the configurations
    * to be registered to the current AliRoot setup by checking the
    * runloader.
-   * @param handler   [in] the configuration handler
-   * @param rawReader [in] AliRoot RawReader instance 
-   * @param runloader [in] AliRoot runloader
+   * @param [in] handler   the configuration handler
+   * @param [in] rawReader AliRoot RawReader instance 
+   * @param [in] runloader AliRoot runloader
    * @return neg. error code if failed
    */
   Int_t CreateConfigurations(AliHLTConfigurationHandler* handler,
@@ -69,8 +69,8 @@ class AliHLTTPCCalibrationAgent : public AliHLTModuleAgent {
    * described by the last configuration(s) in the chain. 
    * The agent can adapt the configurations to be registered to the current
    * AliRoot setup by checking the runloader.
-   * @param rawReader [in] AliRoot RawReader instance 
-   * @param runloader [in] AliRoot runloader
+   * @param [in] rawReader AliRoot RawReader instance 
+   * @param [in] runloader AliRoot runloader
    * @return string containing the top configurations separated by blanks
    */
   const Char_t* GetReconstructionChains(AliRawReader* rawReader=NULL,
@@ -84,7 +84,7 @@ class AliHLTTPCCalibrationAgent : public AliHLTModuleAgent {
 
   /**
    * Register components for the AliHLTSample library.
-   * @param pHandler  [in] instance of the component handler          
+   * @param [in] pHandler  instance of the component handler          
    */
   Int_t RegisterComponents(AliHLTComponentHandler* pHandler) const;
 
index 6e06588508731ad1dae2c1c3fa8c578883e83d29..75d29f611b80b7de612f92559a50879435ec818f 100644 (file)
@@ -68,8 +68,8 @@ class AliHLTTPCCompModelConverter: public AliHLTLogging
       unsigned long GetOutputModelDataSize() const;
       
       /** function to output model data
-       * @param data       pointer to target buffer
-       * @param dataSize   [in] size of buffer, [out] size of data
+       * @param [in] data       pointer to target buffer
+       * @param [in,out] dataSize   [in] size of buffer, [out] size of data
        * @return zero upon success
        */
       int OutputModelData( AliHLTUInt8_t* data, unsigned long& dataSize ) const;
@@ -83,8 +83,8 @@ class AliHLTTPCCompModelConverter: public AliHLTLogging
       unsigned long GetRemainingClustersOutputDataSize() const;
 
       /** function to get remaining clusters
-       * @param data       pointer to target buffer
-       * @param dataSize   [in] size of buffer, [out] size of data
+       * @param [in] data       pointer to target buffer
+       * @param [in,out] dataSize   [in] size of buffer, [out] size of data
        */
       int GetRemainingClusters( AliHLTUInt8_t* const data, unsigned long& dataSize ) const;
       
index e07a8f2d09eabe9984c8d1487d203dbfae41ebd9..e916e984e5b80a6100bcfe31d0150021b2065617 100644 (file)
@@ -98,12 +98,12 @@ class AliHLTTPCDigitPublisherComponent : public AliHLTOfflineDataSource {
 
   /**
    * Data source method.
-   * @param evtData       event data structure
-   * @param trigData     trigger data structure
-   * @param outputPtr    pointer to target buffer
-   * @param size         <i>input</i>: size of target buffer
+   * @param [in] evtData       event data structure
+   * @param [in] trigData        trigger data structure
+   * @param [in] outputPtr       pointer to target buffer
+   * @param [in,out] size        <i>input</i>: size of target buffer
    *                     <i>output</i>:size of produced data
-   * @param outputBlocks  list to receive output block descriptors
+   * @param [in] outputBlocks  list to receive output block descriptors
    * @return neg. error code if failed
    */
   int GetEvent( const AliHLTComponentEventData& evtData,