Fixing in/out tags in documentation
authoraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 11 Jul 2011 21:59:17 +0000 (21:59 +0000)
committeraszostak <aszostak@f7af4fe6-9843-0410-8265-dc069ae4e863>
Mon, 11 Jul 2011 21:59:17 +0000 (21:59 +0000)
18 files changed:
HLT/BASE/AliHLTCalibrationProcessor.h
HLT/BASE/AliHLTComponent.h
HLT/BASE/AliHLTDataSource.h
HLT/BASE/AliHLTDomainEntry.h
HLT/BASE/AliHLTEsdManager.h
HLT/BASE/AliHLTModuleAgent.h
HLT/BASE/AliHLTOUT.h
HLT/BASE/AliHLTOUTHomerBuffer.h
HLT/BASE/AliHLTOUTTask.h
HLT/BASE/AliHLTProcessor.h
HLT/BASE/AliHLTReadoutList.h
HLT/BASE/AliHLTScalars.h
HLT/BASE/util/AliHLTCorruptorComponent.h
HLT/BASE/util/AliHLTFilePublisher.h
HLT/BASE/util/AliHLTFileWriter.h
HLT/BASE/util/AliHLTOUTPublisherComponent.h
HLT/BASE/util/AliHLTRawReaderPublisherComponent.h
HLT/BASE/util/test/testAliHLTCorruptorComponent.C

index af2c4fd..960e968 100644 (file)
@@ -96,13 +96,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * The low-level data processing method for the component,
    * called for every data event. This is the custom processing 
    * method and can be overloaded by the component.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @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] blocks        input data block descriptors
+   * @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
    */
   virtual Int_t ProcessCalibration(const AliHLTComponent_EventData& evtData,
@@ -131,13 +131,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * The low-level data processing method for the component,
    * called for the END_OF_RUN event. This is the custom processing 
    * method and can be overloaded by the component.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @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] blocks        input data block descriptors
+   * @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
    */
   virtual Int_t ShipDataToFXS(const AliHLTComponent_EventData& evtData,
@@ -218,13 +218,13 @@ class AliHLTCalibrationProcessor : public AliHLTProcessor {
    * according to the event type - END_OF_RUN / DATA / CALIBRATION
    * If commandline paramater  "-eventmodulo x"is given and x > 0, data will 
    * be also shipped to the FXS with this modulo.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @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] blocks        input data block descriptors
+   * @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_t DoEvent( const AliHLTComponentEventData& evtData,
index ba19213..9b6795d 100644 (file)
@@ -688,8 +688,8 @@ class AliHLTComponent : public AliHLTLogging {
   /**
    * Copy data type structure
    * Copies the value an AliHLTComponentDataType structure to another one
-   * @param[out] tgtdt   target structure
-   * @param[in] srcdt   source structure
+   * @param [out] tgtdt   target structure
+   * @param [in] srcdt   source structure
    */
   static void CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt);
 
@@ -739,13 +739,13 @@ class AliHLTComponent : public AliHLTLogging {
 
   /**
    * Extracts the different data parts from the trigger data structure.
-   * [in] @param trigData  The trigger data as passed to the DoProcessing method.
-   * [out] @param attributes  The data block attributes given by the HLT framework.
-   * [out] @param status  The HLT status bits given by the HLT framework.
-   * [out] @param cdh  The common data header received from DDL links.
-   * [out] @param readoutlist  The readout list to fill with readout list bits
+   * @param [in] trigData  The trigger data as passed to the DoProcessing method.
+   * @param [out] attributes  The data block attributes given by the HLT framework.
+   * @param [out] status  The HLT status bits given by the HLT framework.
+   * @param [out] cdh  The common data header received from DDL links.
+   * @param [out] readoutlist  The readout list to fill with readout list bits
    *                           passed on by the HLT framework.
-   * [in] @param printErrors  If true then error messages are generated as necessary
+   * @param [in] printErrors  If true then error messages are generated as necessary
    *                          and suppressed otherwise.
    * @note If any of the output parameters are set to NULL then the field is not set.
    *   For example, the following line will only fill the CDH pointer.
@@ -774,9 +774,9 @@ class AliHLTComponent : public AliHLTLogging {
 
   /**
    * Extracts the readout list from a trigger data structure.
-   * [in] @param trigData  The trigger data as passed to the DoProcessing method.
-   * [out] @param list  The output readout list to fill.
-   * [in] @param printErrors  If true then error messages are generated as necessary
+   * @param [in] trigData  The trigger data as passed to the DoProcessing method.
+   * @param [out] list  The output readout list to fill.
+   * @param [in] printErrors  If true then error messages are generated as necessary
    *                          and suppressed otherwise.
    * @return zero on success or one of the error codes returned by ExtractTriggerData.
    */
@@ -790,7 +790,7 @@ class AliHLTComponent : public AliHLTLogging {
 
   /**
    * Extracts the event type from the given Common Data Header.
-   * [in] @param cdh  The Common Data Header to extract the event type from.
+   * @param [in] cdh  The Common Data Header to extract the event type from.
    * @return the event type code from the CDH.
    */
   static AliHLTUInt32_t ExtractEventTypeFromCDH(const AliRawDataHeader* cdh);
index 0f63f99..b70225c 100644 (file)
@@ -79,12 +79,12 @@ protected:
    * The low-level data processing method for the component.
    * This is the custom processing method and can be overloaded by 
    * the component.
-   * @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
    */
   virtual int GetEvent( const AliHLTComponentEventData& evtData,
index 62adc02..851740d 100644 (file)
@@ -296,8 +296,8 @@ class AliHLTDomainEntry : public TObject
    * If we consider the possibility of wild card characters, then the domain entry
    * can be thought of as a set of possible data block entries. This operator
    * therefore effectively implements the set intersection.
-   * \param rhs <i>[in]</i> The domain entry to compare to.
-   * \param result <i>[out]</i>  The resulting intersect is written into this
+   * \param [in]  rhs     The domain entry to compare to.
+   * \param [out] result  The resulting intersect is written into this
    *    variable if this method returns true. The contents is not modified if
    *    there is no intersect and this method returns false.
    * \return true is returned if there is a intersect between the domain entries
index 2b7e7ef..454fbbd 100644 (file)
@@ -70,11 +70,11 @@ class AliHLTEsdManager : public AliHLTLogging {
    * where 'det' is derived from the data type origin. Each time the function is invoked
    * a new event is created. Dummy events are added if the previous events did not contain
    *
-   * @param pBuffer  [in] the data buffer
-   * @param size     [in] data buffer size
-   * @param dt       [in] data type of the block
-   * @param tgtesd   [out] optional target
-   * @param eventno  [in] optional event no
+   * @param [in]  pBuffer  the data buffer
+   * @param [in]  size     data buffer size
+   * @param [in]  dt       data type of the block
+   * @param [out] tgtesd   optional target
+   * @param [in]  eventno  optional event no
    */
   virtual int WriteESD(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, AliHLTComponentDataType dt,
               AliESDEvent* tgtesd=NULL, int eventno=-1)=0;
index c7ab03b..ca1c803 100644 (file)
@@ -155,7 +155,7 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * invocation. In the current stage of development, only one handler
    * can be activated per agent. This is sufficient for the current
    * operation, but can be extended.
-   * @param pHandler  [in] the component handler instance
+   * @param [in] pHandler  the component handler instance
    */
   int ActivateComponentHandler(AliHLTComponentHandler* pHandler);
 
@@ -171,9 +171,9 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * is always NULL and the raw gives access to data. The configurations
    * can adapt to the two cases.
    *
-   * @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
    */
   virtual int CreateConfigurations(AliHLTConfigurationHandler* handler,
@@ -186,8 +186,8 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * 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 run loader and the raw reader.
-   * @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
    */
   virtual const char* GetReconstructionChains(AliRawReader* rawReader=NULL,
@@ -211,7 +211,7 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * - @ref AliHLTComponentHandler::AddComponent                           <br>
    *        Same functionality but handler deletes the object at the end.
    *
-   * @param pHandler  [in] instance of the component handler          
+   * @param [in] pHandler  instance of the component handler          
    */
   virtual int RegisterComponents(AliHLTComponentHandler* pHandler) const;
 
@@ -315,9 +315,9 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * - details how it will handle it, mainly the type of the handler
    *   @ref AliHLTOUTHandlerType
    * 
-   * @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
    */
   virtual int GetHandlerDescription(AliHLTComponentDataType dt,
@@ -333,8 +333,8 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
    * The framework first collects the handlers for all data blocks, and
    * calls the @ref AliHLTOUTHandler::ProcessData method afterwords for
    * each handler.
-   * @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
    */
   virtual AliHLTOUTHandler* GetOutputHandler(AliHLTComponentDataType dt,
@@ -352,9 +352,9 @@ class AliHLTModuleAgent : public TObject, public AliHLTLogging {
 
   /**
    * Get raw stream for a data block.
-   * @param dt        [in] data type of the block
-   * @param spec      [in] specification of the block
-   * @param pData     [in] data control object
+   * @param [in] dt        data type of the block
+   * @param [in] spec      specification of the block
+   * @param [in] pData     data control object
    * @return Rawstream object, NULL if no Rawstream available for data type/spec
    */
   // this method is likely to be moved to a specific implementation
index 747cfba..5d643b9 100644 (file)
@@ -207,8 +207,8 @@ class AliHLTOUT {
 
     /**
      * Get the data buffer
-     * @param pBuffer [out] buffer of the selected data block
-     * @param size    [out] size of the selected data block
+     * @param [out] pBuffer buffer of the selected data block
+     * @param [out] size    size of the selected data block
      */
     int GetDataBuffer(const AliHLTUInt8_t* &pBuffer, AliHLTUInt32_t& size) {
       if (fpCollection) return fpCollection->GetDataBuffer(GetIndex(), pBuffer, size);
@@ -390,10 +390,10 @@ class AliHLTOUT {
    * kAliHLTVoidDataSpec in order to be ignored and just match any data block.
    *
    * The search criteria can be combined with a handler type (e.g. kRawReader)
-   * @param dt    [in]  data type to match                                <br>
-   * @param spec  [in]  data specification to match                       <br>
-   * @param handlerType [in]  type of the handler
-   * @param skipProcessed [in] skip all block marked processed
+   * @param [in] dt     data type to match                                <br>
+   * @param [in] spec   data specification to match                       <br>
+   * @param [in] handlerType  type of the handler
+   * @param [in] skipProcessed skip all block marked processed
    * @return block index: >= 0 if success, -ENOENT if no block found      <br>
    *         neg. error code if failed                                    <br>
    *                        -EPERM if access denied (object locked)
@@ -414,8 +414,8 @@ class AliHLTOUT {
 
   /**
    * Get properties of the selected data block.
-   * @param dt    [out] data type of the selected block
-   * @param spec  [out] data specification of the selected block
+   * @param [out] dt    data type of the selected block
+   * @param [out] spec  data specification of the selected block
    */
   int GetDataBlockDescription(AliHLTComponentDataType& dt, AliHLTUInt32_t& spec);
 
@@ -438,14 +438,14 @@ class AliHLTOUT {
 
   /**
    * Get buffer of the selected data block.
-   * @param pBuffer [out] buffer of the selected data block
-   * @param size    [out] size of the selected data block
+   * @param [out] pBuffer buffer of the selected data block
+   * @param [out] size    size of the selected data block
    */
   int GetDataBuffer(const AliHLTUInt8_t* &pBuffer, AliHLTUInt32_t& size);
 
   /**
    * Release buffer after use.
-   * @param pBuffer [in]  buffer of the selected data block
+   * @param [in] pBuffer  buffer of the selected data block
    */
   int ReleaseDataBuffer(const AliHLTUInt8_t* pBuffer);
 
@@ -528,10 +528,10 @@ class AliHLTOUT {
    * The function needs AliRoot and might not be implemented by all AliHLTOUT
    * implementations.
    * a data block of this specification.
-   * @param pBuffer  [in] the data buffer
-   * @param size     [in] data buffer size
-   * @param dt       [in] data type of the block
-   * @param tgtesd   [out] optional target
+   * @param [in]  pBuffer  the data buffer
+   * @param [in]  size     data buffer size
+   * @param [in]  dt       data type of the block
+   * @param [out] tgtesd   optional target
    */
   virtual int WriteESD(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, AliHLTComponentDataType dt, AliESDEvent* tgtesd=NULL) const;
 
@@ -680,9 +680,9 @@ class AliHLTOUT {
 
   /**
    * Get the data buffer
-   * @param index   [in]  index of the block
-   * @param pBuffer [out] buffer of the selected data block
-   * @param size    [out] size of the selected data block
+   * @param [in]  index   index of the block
+   * @param [out] pBuffer buffer of the selected data block
+   * @param [out] size    size of the selected data block
    */
   virtual int GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer, 
                            AliHLTUInt32_t& size)=0;
index c23aef3..8130a9e 100644 (file)
@@ -65,9 +65,9 @@ class AliHLTOUTHomerBuffer : public AliHLTOUT, public AliHLTLogging {
 
   /**
    * Get the data buffer
-   * @param index   [in]  index of the block
-   * @param pBuffer [out] buffer of the selected data block
-   * @param size    [out] size of the selected data block
+   * @param [in]  index   index of the block
+   * @param [out] pBuffer buffer of the selected data block
+   * @param [out] size    size of the selected data block
    */
   virtual int GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer, 
                            AliHLTUInt32_t& size);
index 2a57f6e..b627e3f 100644 (file)
@@ -55,9 +55,9 @@ class AliHLTOUTTask : public AliHLTOUT, public AliHLTDumpTask {
 
   /**
    * Get the data buffer
-   * @param index   [in]  index of the block
-   * @param pBuffer [out] buffer of the selected data block
-   * @param size    [out] size of the selected data block
+   * @param [in] index    index of the block
+   * @param [out] pBuffer buffer of the selected data block
+   * @param [out] size    size of the selected data block
    */
   int GetDataBuffer(AliHLTUInt32_t index, const AliHLTUInt8_t* &pBuffer, 
                    AliHLTUInt32_t& size);
index 3b6b23c..d95c263 100644 (file)
@@ -70,13 +70,13 @@ class AliHLTProcessor : public AliHLTComponent {
    * The low-level data processing method for the component.
    * This is the custom processing method and can be overloaded by 
    * the component.
-   * @param evtData       event data structure
-   * @param blocks        input data block descriptors
-   * @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] blocks        input data block descriptors
+   * @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                                <br>
    *         -ENOSPC      output buffer too small
    */
index eb67410..339c0d0 100644 (file)
@@ -383,10 +383,9 @@ class AliHLTReadoutList : public TNamed
   
   /**
    * Decodes the word index and bit index within that word for the readout list structure.
-   * \param ddlId <i>[in]</i>  The ID number of the DDL to decode.
-   * \param wordIndex <i>[out]</i>  the word index of the word to modify or check
-   *    within fReadoutList.fList
-   * \param bitIndex <i>[out]</i>   the bit index of the bit to modify or check
+   * \param [in] ddlId   The ID number of the DDL to decode.
+   * \param [out] wordIndex  the word index of the word to modify or check within fReadoutList.fList
+   * \param [out] bitIndex   the bit index of the bit to modify or check
    *    within the word pointed to by <i>wordIndex</i>.
    * \return  true if the ddlId was decoded and false if it was invalid.
    * \note We do not check extensively if the ddlId is invalid. Just simple checks
index 3452e0a..f744735 100644 (file)
@@ -294,11 +294,11 @@ protected:
        /**
         * This is an internal Add method which can be faster to use than the public Add method
         * directly for classes derived from AliHLTScalars.
-        * [out] \param scalar This gets filled with the pointer of the new scalar created or
+        * \param [out] scalar This gets filled with the pointer of the new scalar created or
         *    the existing one found.
-        * [in] \param name The name of the scalar.
-        * [in] \param description  A short description of the scalar.
-        * [in] \param value  The value of the new scalar.
+        * \param [in] name The name of the scalar.
+        * \param [in] description  A short description of the scalar.
+        * \param [in] value  The value of the new scalar.
         * \returns true if the scalar already exists and false otherwise.
         */
        bool Add(AliScalar*& scalar, const char* name, const char* description, Double_t value);
index fd2918e..f5e378d 100644 (file)
@@ -262,38 +262,38 @@ private:
        
        /**
         * Converts the value to a positive 64 bit integer.
-        * [in]  \param value  The command line parameter to convert.
-        * [out] \param num  The result is stored in this variable.
-        * [in]  \param printErrors Indicates if error messages should be generated.
+        * \param [in]  value  The command line parameter to convert.
+        * \param [out] num  The result is stored in this variable.
+        * \param [in]  printErrors Indicates if error messages should be generated.
         * \returns true if the convertion was successful.
         */
        bool ConvertToPositiveInt(const char* value, AliHLTUInt64_t& num, bool printErrors = true) const;
        
        /**
         * Converts the value to a bit position.
-        * [in]  \param value  The command line parameter to convert.
-        * [out] \param pos  The result is stored in this variable.
-        * [out] \param relative  Flag filled to indicate if the resulting position
+        * \param [in]  value  The command line parameter to convert.
+        * \param [out] pos  The result is stored in this variable.
+        * \param [out] relative  Flag filled to indicate if the resulting position
         *                        is relative to the end of the data block buffer.
-        * [in]  \param printErrors Indicates if error messages should be generated.
+        * \param [in]  printErrors Indicates if error messages should be generated.
         * \returns true if the convertion was successful.
         */
        bool ConvertToBitPosition(const char* value, AliHLTUInt64_t& pos, bool& relative, bool printErrors = true) const;
        
        /**
         * Converts the value to a percentage fraction in the range [0..1].
-        * [in]  \param value  The command line parameter to convert.
-        * [out] \param num  The result is stored in this variable.
-        * [in]  \param printErrors Indicates if error messages should be generated.
+        * \param [in]  value  The command line parameter to convert.
+        * \param [out] num  The result is stored in this variable.
+        * \param [in]  printErrors Indicates if error messages should be generated.
         * \returns true if the convertion was successful.
         */
        bool ConvertToPercentage(const char* value, double& num, bool printErrors = true) const;
        
        /**
         * Converts a string to a pattern for the -replace and -insert command line options.
-        * [in]  \param value  The command line parameter to convert.
-        * [out] \param pattern  The resulting pattern structure.
-        * [in]  \param printErrors Indicates if error messages should be generated.
+        * \param [in]  value  The command line parameter to convert.
+        * \param [out] pattern  The resulting pattern structure.
+        * \param [in]  printErrors Indicates if error messages should be generated.
         * \returns true if the convertion was successful.
         */
        bool ConvertToPattern(const char* value, AliPattern& pattern, bool printErrors = true) const;
index fe38ba3..dc7059f 100644 (file)
@@ -123,12 +123,12 @@ class AliHLTFilePublisher : public AliHLTDataSource  {
 
   /**
    * Data processing method for the component.
-   * @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
    */
   int GetEvent( const AliHLTComponentEventData& evtData,
index cd582bd..e13e4b5 100644 (file)
@@ -202,13 +202,13 @@ class AliHLTFileWriter : public AliHLTDataSink  {
 
   /**
    * Build file name from eventID data type and the specified directory and basename.
-   * @param eventID [in]   the ID of the event
-   * @param blockID [in]   the ID of the current block
+   * @param [in] eventID   the ID of the event
+   * @param [in] blockID   the ID of the current block
    *                       no block string appended if -1
-   * @param dataType [in]  the data type of the data block
+   * @param [in] dataType  the data type of the data block
    *                       no type string appanded if @ref kAliHLTVoidDataType
-   * @param specification  data specification of the block
-   * @param filename [out] string to receive the file name
+   * @param [in] specification  data specification of the block
+   * @param [out] filename string to receive the file name
    */
   int BuildFileName(const AliHLTEventID_t eventID, const int blockID,
                    const AliHLTComponentDataType& dataType,
index 72e4c2e..3e7dbd5 100644 (file)
@@ -108,12 +108,12 @@ class AliHLTOUTPublisherComponent : 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,
index a690386..aba97cb 100644 (file)
@@ -138,12 +138,12 @@ class AliHLTRawReaderPublisherComponent : 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,
index ef50181..9da45d8 100644 (file)
@@ -129,11 +129,11 @@ void RunChainToCheckFiltering(bool debug = false)
 
 /**
  * Reads a file into a buffer.
- * [in]  \param filename  The name of the file to read.
- * [out] \param buffer  The buffer which is created to store the contents.
+ * \param [in]  filename  The name of the file to read.
+ * \param [out] buffer  The buffer which is created to store the contents.
  *                      Must be deleted with 'delete [] buffer' by caller if not NULL.
- * [out] \param size  The size of the buffer created in bytes.
- * [in]  \param debug  Indicates if debug messages should be printed.
+ * \param [out] size  The size of the buffer created in bytes.
+ * \param [in]  debug  Indicates if debug messages should be printed.
  * \returns true if the file was read, the buffer created and filled; false otherwise.
  * \note The caller becomes the owner of the allocated buffer.
  */