diff --git a/src/Xrd/XrdLink.hh b/src/Xrd/XrdLink.hh
index 1f1c569..05569d3 100644
--- a/src/Xrd/XrdLink.hh
+++ b/src/Xrd/XrdLink.hh
@@ -81,7 +81,7 @@ XrdNetAddrInfo *AddrInfo() {return (XrdNetAddrInfo *)&Addr;}
//! Allocate a new link object.
//!
//! @param peer The connection information for the endpoint.
-//! opts Processing options:
+//! @param opts Processing options:
//! XRDLINK_NOCLOSE - do not close the FD upon recycling.
//! XRDLINK_RDLOCK - obtain a lock prior to reading data.
//!
diff --git a/src/XrdCks/XrdCks.hh b/src/XrdCks/XrdCks.hh
index 9dc51ce..b036d13 100644
--- a/src/XrdCks/XrdCks.hh
+++ b/src/XrdCks/XrdCks.hh
@@ -56,7 +56,7 @@ public:
//! @param Pfn The physical name of the file to be checksumed.
//! @param Cks For input, it specifies the checksum algorithm to be used.
//! For output, the checksum value is returned upon success.
-//! @param doset When true, the new value must replace any existing value
+//! @param doSet When true, the new value must replace any existing value
//! in the Pfn's extended file attributes.
//!
//! @return Success: zero with Cks structure holding the checksum value.
@@ -168,7 +168,7 @@ XrdCksCalc *Object(const char *name)
//------------------------------------------------------------------------------
//! Get the binary length of the checksum with the corresponding name.
//!
-//! @param name. The checksum algorithm name. If null, use the default name.
+//! @param Name The checksum algorithm name. If null, use the default name.
//!
//! @return Success: checksum length.
//! Failure: Zero if the checksum name does not exist.
diff --git a/src/XrdCl/XrdClCopyProcess.hh b/src/XrdCl/XrdClCopyProcess.hh
index f297226..d853e15 100644
--- a/src/XrdCl/XrdClCopyProcess.hh
+++ b/src/XrdCl/XrdClCopyProcess.hh
@@ -62,6 +62,7 @@ namespace XrdCl
//------------------------------------------------------------------------
//! Notify when the previous job has finished
//!
+ //! @param jobNum job number
//! @param result result of the job
//------------------------------------------------------------------------
virtual void EndJob( uint16_t jobNum,
@@ -73,6 +74,7 @@ namespace XrdCl
//------------------------------------------------------------------------
//! Notify about the progress of the current job
//!
+ //! @param jobNum job number
//! @param bytesProcessed bytes processed by the current job
//! @param bytesTotal total number of bytes to be processed by the
//! current job
diff --git a/src/XrdCl/XrdClMonitor.hh b/src/XrdCl/XrdClMonitor.hh
index 5332ae4..0ea025c 100644
--- a/src/XrdCl/XrdClMonitor.hh
+++ b/src/XrdCl/XrdClMonitor.hh
@@ -73,7 +73,7 @@ namespace XrdCl
sTOD.tv_sec = 0; sTOD.tv_usec = 0;
eTOD.tv_sec = 0; eTOD.tv_usec = 0;
}
- std::string server; //!< user@host:port
+ std::string server; //!< user\@host:port
std::string auth; //!< authentication protocol used or empty if none
timeval sTOD; //!< gettimeofday() when login started
timeval eTOD; //!< gettimeofday() when login ended
@@ -87,7 +87,7 @@ namespace XrdCl
{
DisconnectInfo(): rBytes(0), sBytes(0), cTime(0)
{}
- std::string server; //!< user@host:port
+ std::string server; //!< user\@host:port
uint64_t rBytes; //!< Number of bytes received
uint64_t sBytes; //!< Number of bytes sent
time_t cTime; //!< Seconds connected to the server
@@ -195,7 +195,7 @@ namespace XrdCl
{
CheckSumInfo(): oTime(0), tTime(0), isOK(false) {}
TransferInfo transfer; //!< The transfer in question
- std::string cksum; //!< Checksum as <type>:<value>
+ std::string cksum; //!< Checksum as \<type\>:\<value\>
uint64_t oTime; //!< Microseconds to obtain cksum from origin
uint64_t tTime; //!< Microseconds to obtain cksum from target
bool isOK; //!< True if checksum matched, false otherwise
@@ -221,8 +221,8 @@ namespace XrdCl
//------------------------------------------------------------------------
//! Inform the monitor of an event.
//!
- //! @parm evCode is the event that occurred (see enum evNum)
- //! @parm evInfo is the event information structure describing the event
+ //! @param evCode is the event that occurred (see enum evNum)
+ //! @param evData is the event information structure describing the event
//! it is cast to (void *) so that one method can be used
//! and should be recast to the correct corresponding struct
//------------------------------------------------------------------------
diff --git a/src/XrdCl/XrdClPostMaster.hh b/src/XrdCl/XrdClPostMaster.hh
index 2e15be1..ed8e179 100644
--- a/src/XrdCl/XrdClPostMaster.hh
+++ b/src/XrdCl/XrdClPostMaster.hh
@@ -86,7 +86,7 @@ namespace XrdCl
//!
//! @param url recipient of the message
//! @param msg message to be sent
- //! @param statful physical stream disconnection causes an error
+ //! @param stateful physical stream disconnection causes an error
//! @param expires unix timestamp after which a failure should be
//! reported if sending was unsuccessful
//! @return success if the message has been pushed through the wire,
diff --git a/src/XrdCl/XrdClXRootDResponses.hh b/src/XrdCl/XrdClXRootDResponses.hh
index 5ae1ec4..4543be5 100644
--- a/src/XrdCl/XrdClXRootDResponses.hh
+++ b/src/XrdCl/XrdClXRootDResponses.hh
@@ -841,7 +841,7 @@ namespace XrdCl
//! @param status status of the request
//! @param response an object associated with the response
//! (request dependent)
- //! @param urlList list of hosts the request was redirected to
+ //! @param hostList list of hosts the request was redirected to
//------------------------------------------------------------------------
virtual void HandleResponseWithHosts( XRootDStatus *status,
AnyObject *response,
diff --git a/src/XrdClient/XrdClientAbs.hh b/src/XrdClient/XrdClientAbs.hh
index a83a868..67a0b63 100644
--- a/src/XrdClient/XrdClientAbs.hh
+++ b/src/XrdClient/XrdClientAbs.hh
@@ -99,12 +99,16 @@ public:
// Asks for the value of some parameter
//---------------------------------------------------------------------------
+ //! @param ReqCode request code
+ //! @param Args arguments
//! @param Resp a prealocated buffer
//! @param MaxResplen size of the buffer
//---------------------------------------------------------------------------
bool Query(kXR_int16 ReqCode, const kXR_char *Args, kXR_char *Resp, kXR_int32 MaxResplen);
//---------------------------------------------------------------------------
+ //! @param ReqCode request code
+ //! @param Args arguments
//! @param Resp pointer to a preallocated buffer or a pointer to 0 if a
//! sufficiently large buffer should be allocated automagically,
//! in which case the buffer needs to be freed with free()
diff --git a/src/XrdCms/XrdCmsClient.hh b/src/XrdCms/XrdCmsClient.hh
index 220e75f..2c7c209 100644
--- a/src/XrdCms/XrdCmsClient.hh
+++ b/src/XrdCms/XrdCmsClient.hh
@@ -159,6 +159,7 @@ virtual int Configure(const char *cfn, char *Parms, XrdOucEnv *EnvInfo) = 0;
//! @param Env2 Associated environmental information for arg2 (e.g., cgi info
//! which can be retrieved by Env1->Env(<len>)).
//!
+//!
//! cmd arg1 arg2 cmd arg1 arg2
//! -------- ------ ------ -------- ------ ------
//! [+]chmod <path> <mode %o> [+]rmdir <path> 0
@@ -166,7 +167,7 @@ virtual int Configure(const char *cfn, char *Parms, XrdOucEnv *EnvInfo) = 0;
//! [+]mkpath <path> <mode %o> [+]trunc <path> <size %lld>
//! [+]rm <path> 0
//!
-//! @Return: As explained under "return conventions".
+//! @return As explained under "return conventions".
//------------------------------------------------------------------------------
virtual int Forward(XrdOucErrInfo &Resp, const char *cmd,
diff --git a/src/XrdFileCache/XrdFileCacheDecision.hh b/src/XrdFileCache/XrdFileCacheDecision.hh
index b59bf8d..d85b07a 100644
--- a/src/XrdFileCache/XrdFileCacheDecision.hh
+++ b/src/XrdFileCache/XrdFileCacheDecision.hh
@@ -51,11 +51,11 @@ namespace XrdFileCache
//------------------------------------------------------------------------------
//! Parse configuration arguments.
//!
- //! @param char* configuration parameters
+ //! @param params configuration parameters
//!
//! @return status of configuration
//------------------------------------------------------------------------------
- virtual bool ConfigDecision(const char*) { return true; }
+ virtual bool ConfigDecision(const char* params) { return true; }
};
}
diff --git a/src/XrdOss/XrdOssStatInfo.hh b/src/XrdOss/XrdOssStatInfo.hh
index 019d6a6..1fe4857 100644
--- a/src/XrdOss/XrdOssStatInfo.hh
+++ b/src/XrdOss/XrdOssStatInfo.hh
@@ -108,7 +108,7 @@ typedef int (*XrdOssStatInfo2_t)(const char *path, struct stat *buff,
An alternate entry point may be defined in lieu of the previous entry point.
This normally identified by a version option in the configuration file (e.g.
- oss.statlib -2 <path>). It differs in that an extra parameter is passed and
+ oss.statlib -2 \<path\>). It differs in that an extra parameter is passed and
if returns a function that accepts an extra parameter.
@param envP - Pointer to the environment containing implementation
@@ -128,10 +128,10 @@ typedef int (*XrdOssStatInfo2_t)(const char *path, struct stat *buff,
//! your plug-in. Include the code shown below at file level in your source.
//------------------------------------------------------------------------------
-/*! #include "XrdVersion.hh"
- XrdVERSIONINFO(XrdOssStatInfoInit,<name>);
+/*! #include "XrdVersion.hh"
+ XrdVERSIONINFO(XrdOssStatInfoInit,<name>);
- where <name> is a 1- to 15-character unquoted name identifying your plugin.
+ where \<name\> is a 1- to 15-character unquoted name identifying your plugin.
*/
//------------------------------------------------------------------------------
diff --git a/src/XrdOuc/XrdOucErrInfo.hh b/src/XrdOuc/XrdOucErrInfo.hh
index e08caf5..6f873ed 100644
--- a/src/XrdOuc/XrdOucErrInfo.hh
+++ b/src/XrdOuc/XrdOucErrInfo.hh
@@ -239,6 +239,7 @@ inline XrdOucEICB *getErrCB(unsigned long long &ap)
inline int getErrInfo() {return ErrInfo.code;}
+/*
//-----------------------------------------------------------------------------
//! Get a copy of the error information.
//!
@@ -246,7 +247,6 @@ inline int getErrInfo() {return ErrInfo.code;}
//!
//! @return The error code that was previously set.
//-----------------------------------------------------------------------------
-/*
inline int getErrInfo(XrdOucEI &errParm)
{errParm = ErrInfo; return ErrInfo.code;}
*/
@@ -439,7 +439,7 @@ inline void setUCap(int ucval) {ErrInfo.ucap = ucval;}
//! Constructor
//!
//! @param user - Pointer to he user string in stable storage.
-//! @param MonId - The monitoring identifier.
+//! @param MonID - The monitoring identifier.
//! @param uc - The user capabilities.
//-----------------------------------------------------------------------------
@@ -494,7 +494,7 @@ public:
//! function after the actual callback message is sent. This
//! allows the callback requestor to do post-processing and be
//! asynchronous being assured that the callback completed.
-//! Path - Optionally, the path related to thid request. It is used
+//! @param Path - Optionally, the path related to thid request. It is used
//! for tracing and detailed monitoring purposes.
//-----------------------------------------------------------------------------
diff --git a/src/XrdPosix/XrdPosixXrootd.hh b/src/XrdPosix/XrdPosixXrootd.hh
index 1fde8ab..3ce4bb0 100644
--- a/src/XrdPosix/XrdPosixXrootd.hh
+++ b/src/XrdPosix/XrdPosixXrootd.hh
@@ -85,7 +85,7 @@ static int Closedir(DIR *dirp);
//! endPoint() is a POSIX extension and returns the location of an open file.
//!
//! @param FD File descriptor of an open file in question.
-//! @param Buff Pointer to the buffer to receive '<host>:<port>' of the server.
+//! @param Buff Pointer to the buffer to receive '\<host\>:\<port\>' of the server.
//! @param Blen Size of the buffer, it must be big enough for the result.
//!
//! @return >= 0 The numeric port number of the data server.
diff --git a/src/XrdSec/XrdSecInterface.hh b/src/XrdSec/XrdSecInterface.hh
index 6e144cb..83a5c95 100644
--- a/src/XrdSec/XrdSecInterface.hh
+++ b/src/XrdSec/XrdSecInterface.hh
@@ -190,9 +190,9 @@ virtual XrdSecCredentials *getCredentials(XrdSecParameters *parm=0,
//! The caller is responsible for deleting the returned object.
//------------------------------------------------------------------------------
-virtual int Encrypt(const char * /*inbuff*/, // Data to be encrypted
- int /*inlen*/, // Length of data in inbuff
- XrdSecBuffer ** /*outbuff*/ // Returns encrypted data
+virtual int Encrypt(const char *inbuff, // Data to be encrypted
+ int inlen, // Length of data in inbuff
+ XrdSecBuffer **outbuff // Returns encrypted data
) {return -ENOTSUP;}
//------------------------------------------------------------------------------
@@ -207,9 +207,9 @@ virtual int Encrypt(const char * /*inbuff*/, // Data to be encrypted
//! The caller is responsible for deleting the returned object.
//------------------------------------------------------------------------------
-virtual int Decrypt(const char * /*inbuff*/, // Data to be decrypted
- int /*inlen*/, // Length of data in inbuff
- XrdSecBuffer ** /*outbuff*/ // Buffer for decrypted data
+virtual int Decrypt(const char *inbuff, // Data to be decrypted
+ int inlen, // Length of data in inbuff
+ XrdSecBuffer **outbuff // Buffer for decrypted data
) {return -ENOTSUP;}
//------------------------------------------------------------------------------
@@ -224,9 +224,9 @@ virtual int Decrypt(const char * /*inbuff*/, // Data to be decrypted
//! The caller is responsible for deleting the returned object.
//------------------------------------------------------------------------------
-virtual int Sign(const char * /*inbuff*/, // Data to be signed
- int /*inlen*/, // Length of data in inbuff
- XrdSecBuffer ** /*outbuff*/ // Buffer for the signature
+virtual int Sign(const char *inbuff, // Data to be signed
+ int inlen, // Length of data in inbuff
+ XrdSecBuffer **outbuff // Buffer for the signature
) {return -ENOTSUP;}
//------------------------------------------------------------------------------
@@ -242,10 +242,10 @@ virtual int Sign(const char * /*inbuff*/, // Data to be signed
//! > 0 Failed to verify, signature does not match inbuff data.
//------------------------------------------------------------------------------
-virtual int Verify(const char * /*inbuff*/, // Data to be decrypted
- int /*inlen*/, // Length of data in inbuff
- const char * /*sigbuff*/, // Buffer for signature
- int /*siglen*/) // Length if signature
+virtual int Verify(const char *inbuff, // Data to be decrypted
+ int inlen, // Length of data in inbuff
+ const char *sigbuff, // Buffer for signature
+ int siglen) // Length if signature
{return -ENOTSUP;}
//------------------------------------------------------------------------------
@@ -261,7 +261,7 @@ virtual int Verify(const char * /*inbuff*/, // Data to be decrypted
//!
//------------------------------------------------------------------------------
-virtual int getKey(char * /*buff*/=0, int /*size*/=0) {return -ENOTSUP;}
+virtual int getKey(char *buff = 0, int size = 0) {return -ENOTSUP;}
//------------------------------------------------------------------------------
//! Set the current encryption key
@@ -273,7 +273,7 @@ virtual int getKey(char * /*buff*/=0, int /*size*/=0) {return -ENOTSUP;}
//! = 0 The new key has been set.
//------------------------------------------------------------------------------
-virtual int setKey(char * /*buff*/, int /*size*/) {return -ENOTSUP;}
+virtual int setKey(char *buff, int size) {return -ENOTSUP;}
//------------------------------------------------------------------------------
//! Delete the protocol object. DO NOT use C++ delete() on this object.
@@ -368,15 +368,17 @@ virtual ~XrdSecProtocol() {}
//! a client.
//! 2) This function must be thread-safe.
//! 3) Additionally, you *should* declare the xrootd version you used
-//! to compile your plug-in using XrdVERSIONINFO where <name> is
+//! to compile your plug-in using XrdVERSIONINFO where \<name\> is
//! the 1- to 15-character unquoted name of your plugin. This is a
//! mandatory requirement!
//------------------------------------------------------------------------------
-/*! #include "XrdVersion.hh"
- XrdVERSIONINFO(XrdSecProtocol<p>Object,<name>);
+/*! Example:
- extern "C" XrdSecProtocol *XrdSecProtocol<p>Object
+ #include "XrdVersion.hh"
+ XrdVERSIONINFO(XrdSecProtocol<p>Object,<name>);
+
+ extern "C" XrdSecProtocol *XrdSecProtocol<p>Object
(const char who,
const char *hostname,
XrdnetAddrInfo &endPoint,
@@ -428,7 +430,7 @@ virtual ~XrdSecProtocol() {}
//! 4) When replacing the default implementation with a plug-in the
//! extern "C" function below must exist in your shared library.
//! 5) Additionally, you *should* declare the xrootd version you used
-//! to compile your plug-in using XrdVERSIONINFO where <name> is
+//! to compile your plug-in using XrdVERSIONINFO where \<name\> is
//! the 1- to 15-character unquoted name of your plugin. This is a
//! mandatory requirement!
//------------------------------------------------------------------------------
@@ -442,11 +444,13 @@ typedef XrdSecProtocol *(*XrdSecGetProt_t)(const char *,
XrdSecParameters &,
XrdOucErrInfo *);
-/*!
-#include "XrdVersion.hh"
-XrdVERSIONINFO(XrdSecGetProtocol,<name>);
+/*! Example:
+
+ #include "XrdVersion.hh"
+ XrdVERSIONINFO(XrdSecGetProtocol,<name>);
-extern "C" XrdSecProtocol *XrdSecGetProtocol(const char *hostname,
+ extern "C" XrdSecProtocol *XrdSecGetProtocol
+ (const char *hostname,
XrdNetAddrInfo &endPoint,
XrdSecParameters §oken,
XrdOucErrInfo *einfo=0)
@@ -555,7 +559,7 @@ virtual ~XrdSecService() {}
//! own plugin, the extern "C" function below must be defined in
//! your plugin shared library.
//! 3) Additionally, you *should* declare the xrootd version you used
-//! to compile your plug-in using XrdVERSIONINFO where <name> is
+//! to compile your plug-in using XrdVERSIONINFO where \<name\> is
//! the 1- to 15-character unquoted name of your plugin. This is a
//! mandatory requirement!
//------------------------------------------------------------------------------
@@ -568,10 +572,11 @@ virtual ~XrdSecService() {}
class XrdSysLogger;
typedef XrdSecService *(*XrdSecGetServ_t)(XrdSysLogger *, const char *);
-/*!
-#include "XrdVersion.hh"
-XrdVERSIONINFO(XrdSecgetService,<name>);
+/*! Example:
+
+ #include "XrdVersion.hh"
+ XrdVERSIONINFO(XrdSecgetService,<name>);
-extern "C" XrdSecService *XrdSecgetService(XrdSysLogger *lp, const char *cfn)
+ extern "C" XrdSecService *XrdSecgetService(XrdSysLogger *lp, const char *cfn)
*/
#endif
diff --git a/src/XrdSys/XrdSysIOEvents.hh b/src/XrdSys/XrdSysIOEvents.hh
index 79abec3..8e5bc67 100644
--- a/src/XrdSys/XrdSysIOEvents.hh
+++ b/src/XrdSys/XrdSysIOEvents.hh
@@ -251,7 +251,7 @@ enum EventCode {readEvents = 0x01, //!< Read and Read Timeouts
//! Get the callback object and argument associated with this channel.
//!
//! @param cbP Place where the pointer is to be returned.
-//! @param caP Place where the callback argument is to be returned.
+//! @param cbArg Place where the callback argument is to be returned.
//-----------------------------------------------------------------------------
void GetCallBack(CallBack **cbP, void **cbArg);
diff --git a/src/XrdSys/XrdSysLogger.hh b/src/XrdSys/XrdSysLogger.hh
index 18a0efc..97799d8 100644
--- a/src/XrdSys/XrdSysLogger.hh
+++ b/src/XrdSys/XrdSysLogger.hh
@@ -54,7 +54,7 @@ public:
//-----------------------------------------------------------------------------
//! Constructor
//!
-//! @param errFD is the filedescriptor of where error messages normally
+//! @param ErrFD is the filedescriptor of where error messages normally
//! go if this class is not used. Default is stderr.
//! @param xrotate when not zero performs internal log rotatation. Otherwise,
//! log rotation is suppressed. See also setRotate().
@@ -146,7 +146,7 @@ int originalFD() {return baseFD;}
//! Parse the keep option argument.
//!
//! @param arg Pointer to the argument. The argument syntax is:
-//! <count> | <size> | fifo | <signame>
+//! \<count\> | \<size\> | fifo | \<signame\>
//!
//! @return !0 Parsing succeeded. The return value is the argument that
//! must be passed as the lfh parameter to Bind().