Changeset 20996

Show
Ignore:
Timestamp:
01/12/08 06:48:02 (11 months ago)
Author:
patrick
Message:

MFT r20992-r20995: Silenced Doxygen warnings and improved comments.

No functional changes.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/branches/2.2/modules/vapor/vpr/DynLoad/LibraryLoader.h

    r20500 r20996  
    237237    * the name of the shared library to load. 
    238238    * 
    239     * @parram nameExt The new name extension (such as "_x") that will be used 
    240     *                by makeFullDSOName(). 
     239    * @param nameExt The new name extension (such as "_x") that will be used 
     240    *                by makeFullDSOName(). 
    241241    * 
    242242    * @since 1.1.47 

  • juggler/branches/2.2/modules/vapor/vpr/IO/Port/SerialPort_t.h

    r20267 r20996  
    772772    * (except BREAKs).  This is only active if input parity and framing error 
    773773    * reporting is enabled (see setInputParityCheck() for more information). 
    774     * The mark is the three-byte sequence \377 \0 X where X is the byte 
    775     * received in error.  If bit stripping is enabled, a valid \377 byte is 
    776     * passed as the two-byte sequence \377 \377. 
     774    * The mark is the three-byte sequence 0377 0 X where X is the byte 
     775    * received in error.  If bit stripping is enabled, a valid 0377 byte is 
     776    * passed as the two-byte sequence 0377 0377. 
    777777    * 
    778778    * @pre This serial port is open. 
    …… 
    785785    * 
    786786    * @see setInputParityCheck 
     787    * 
     788    * @note 0377 == 0xFF == 255 
    787789    */ 
    788790   void setParityErrorMarking(bool flag) 

  • juggler/branches/2.2/modules/vapor/vpr/IO/Socket/SocketDatagram_t.h

    r19846 r20996  
    128128    * Receives a message from some source.  The source's address is writen 
    129129    * into the by-reference parameter \p from. 
    130     * @throws vpr::IOException if the operation failed. 
     130    * 
     131    * @throw vpr::IOException Thrown if the operation failed. 
    131132    */ 
    132133   vpr::Uint32 recvfrom(void* msg, const vpr::Uint32 len, 
    …… 
    140141    * Receives a message from some source.  The source's address is writen 
    141142    * into the by-reference parameter \p from. 
    142     * @throws vpr::IOException if the operation failed. 
     143    * 
     144    * @throw vpr::IOException Thrown if the operation failed. 
    143145    */ 
    144146   vpr::Uint32 recvfrom(std::string& msg, const vpr::Uint32 len, 
    …… 
    155157    * Receives a message from some source.  The source's address is writen 
    156158    * into the by-reference parameter \p from. 
    157     * @throws vpr::IOException if the operation failed. 
     159    * 
     160    * @throw vpr::IOException Thrown if the operation failed. 
    158161    */ 
    159162   vpr::Uint32 recvfrom(std::vector<vpr::Uint8>& msg, 
    …… 
    175178   /** 
    176179    * Sends a message to the designated recipient. 
    177     * @throws vpr::IOException if the operation failed. 
     180    * 
     181    * @throw vpr::IOException Thrown if the operation failed. 
    178182    */ 
    179183   vpr::Uint32 sendto(const void* msg, const vpr::Uint32 len, 
    …… 
    186190   /** 
    187191    * Sends a message to the designated recipient. 
    188     * @throws vpr::IOException if the operation failed. 
     192    * 
     193    * @throw vpr::IOException Thrown if the operation failed. 
    189194    */ 
    190195   vpr::Uint32 sendto(const std::string& msg, const vpr::Uint32 len, 
    …… 
    198203   /** 
    199204    * Sends a message to the designated recipient. 
    200     * @throws vpr::IOException if the operation failed. 
     205    * 
     206    * @throw vpr::IOException Thrown if the operation failed. 
    201207    */ 
    202208   vpr::Uint32 sendto(const std::vector<vpr::Uint8>& msg, 
    …… 
    210216protected: 
    211217   /** 
    212     * @throws vpr::SocketException. 
     218    * @throw vpr::SocketException 
     219    *           Thrown if querying the indiccated option on this socket fails. 
    213220    */ 
    214221   virtual void getOption(const vpr::SocketOptions::Types option, 
    …… 
    220227 
    221228   /** 
    222     * @throws vpr::SocketException. 
     229    * @throw vpr::SocketException 
     230    *           Thrown if setting the indicated option on this socket fails. 
    223231    */ 
    224232   virtual void setOption(const vpr::SocketOptions::Types option, 

  • juggler/branches/2.2/modules/vapor/vpr/IO/Socket/SocketStream_t.h

    r19729 r20996  
    132132    * @param backlog The maximum length of th queue of pending connections. 
    133133    * 
    134     * @throws vpr::SocketException if the socket could not be put into 
    135     *         a listening state. 
     134    * @throw vpr::SocketException 
     135    *           Thrown if the socket could not be put into a listening state. 
    136136    */ 
    137137   void listen(const int backlog = 5) 
    …… 
    153153    *                return. 
    154154    * 
    155     * @throws vpr::WouldBlockException if this is a non-blocking socket, 
    156     *         and there are no waiting connection requests. 
    157     * @throws vpr::TimeoutException if no connection requests arrived within 
    158     *         the given timeout period. 
    159     * @throws vpr::SocketException if the connection was not accepted because 
    160     *         of an error. 
     155    * @throw vpr::WouldBlockException 
     156    *           Thrown if this is a non-blocking socket, and there are no 
     157    *           waiting connection requests. 
     158    * @throw vpr::TimeoutException 
     159    *           Thrown if no connection requests arrived within the given 
     160    *           timeout period. 
     161    * @throw vpr::SocketException 
     162    *           Thrown if the connection was not accepted because of an error. 
    161163    * 
    162164    * @see open, bind, listen 
    …… 
    182184    * @param backlog   The maximum length of the pending connection queue. 
    183185    * 
    184     * @throws vpr::WouldBlockException if this is a non-blocking socket, 
    185     *         and there are no waiting connection requests. 
    186     * @throws vpr::TimeoutException if no connection requests arrived within 
    187     *         the given timeout period. 
    188     * @throws vpr::SocketException if the connection was not accepted because 
    189     *         of an error. 
     186    * @throw vpr::WouldBlockException 
     187    *           Thrown if this is a non-blocking socket, and there are no 
     188    *           waiting connection requests. 
     189    * @throw vpr::TimeoutException 
     190    *           Thrown if no connection requests arrived within the given 
     191    *           timeout period. 
     192    * @throw vpr::SocketException 
     193    *           Thrown if the connection was not accepted because of an error. 
    190194    */ 
    191195   void openServer(const bool reuseAddr = true, 
    …… 
    221225 
    222226   /** 
    223     * @THROWS vpr::SocketException. 
     227    * @throw vpr::SocketException 
     228    *           Thrown if querying the indiccated option on this socket fails. 
    224229    */ 
    225230   virtual void getOption(const vpr::SocketOptions::Types option, 
    …… 
    231236 
    232237   /** 
    233     * @THROWS vpr::SocketException. 
     238    * @throw vpr::SocketException 
     239    *           Thrown if setting the indicated option on this socket fails. 
    234240    */ 
    235241   virtual void setOption(const vpr::SocketOptions::Types option, 

  • juggler/branches/2.2/modules/vapor/vpr/Perf/ProfileManager.h

    r19729 r20996  
    121121      static void printTree(bool forAllThreads = true); 
    122122 
    123       /** @nameIterator handling. */ 
     123      /** @name Iterator handling. */ 
    124124      //@{ 
    125125      /** Returns a new Iterator that is set to the root. */ 

  • juggler/branches/2.2/modules/vapor/vpr/md/NSPR/Thread/ThreadNSPR.h

    r19729 r20996  
    4747#  include <process.h> 
    4848#endif 
     49 
     50#include <boost/concept_check.hpp> 
    4951 
    5052#include <prthread.h> 
    …… 
    258260    * @note This operation is not currently supported by NSPR threads. 
    259261    */ 
    260    virtual void kill(const int) 
    261    { 
    262       /* Do nothing. */ ; 
     262   virtual void kill(const int signum) 
     263   { 
     264      boost::ignore_unused_variable_warning(signum); 
    263265   } 
    264266 

  • juggler/branches/2.2/modules/vapor/vpr/md/POSIX/IO/Port/SerialPortImplTermios.cpp

    r19846 r20996  
    426426// BREAKs).  This is only active if input parity and framing error reporting 
    427427// is enabled (see getInputParityCheckState() for more information).  The mark 
    428 // is the three-byte sequence \377 \0 X where X is the byte received in error. 
    429 // If bit stripping is enabled, a valid \377 byte is passed as the two-byte 
    430 // sequence \377 \377. 
     428// is the three-byte sequence 0377 0 X where X is the byte received in error. 
     429// If bit stripping is enabled, a valid 0377 byte is passed as the two-byte 
     430// sequence 0377 0377. 
    431431bool SerialPortImplTermios::getParityErrorMarkingState() const 
    432432{ 

  • juggler/branches/2.2/modules/vapor/vpr/md/POSIX/IO/Port/SerialPortImplTermios.h

    r20268 r20996  
    723723    * (except BREAKs).  This is only active if input parity and framing error 
    724724    * reporting is enabled (see setInputParityCheck() for more 
    725     * information).  The mark is the three-byte sequence \377 \0 X where X 
     725    * information).  The mark is the three-byte sequence 0377 0 X where X 
    726726    * is the byte received in error.  If bit stripping is enabled, a valid 
    727     * \377 byte is passed as the two-byte sequence \377 \377. 
     727    * 0377 byte is passed as the two-byte sequence 0377 0377. 
    728728    * 
    729729    * @pre This serial port is open. 
    …… 
    736736    * 
    737737    * @see setInputParityCheck 
     738    * 
     739    * @note 0377 == 0xFF == 255 
    738740    */ 
    739741   void setParityErrorMarking(bool flag); 

  • juggler/branches/2.2/modules/vapor/vpr/md/POSIX/Thread/ThreadPosix.h

    r20820 r20996  
    104104               VPRThreadScope scope = VPR_GLOBAL_THREAD, 
    105105               VPRThreadState state = VPR_JOINABLE_THREAD, 
    106                size_t stack_size = 0); 
     106               size_t stackSize = 0); 
    107107 
    108108   /** 

  • juggler/branches/2.2/modules/vapor/vpr/md/WIN32/IO/Port/SerialPortImplWin32.cpp

    r20268 r20996  
    730730// BREAKs).  This is only active if input parity and framing error reporting 
    731731// is enabled (see getInputParityCheckState() for more information).  The mark 
    732 // is the three-byte sequence \377 \0 X where X is the byte received in error. 
    733 // If bit stripping is enabled, a valid \377 byte is passed as the two-byte 
    734 // sequence \377 \377. 
     732// is the three-byte sequence 0377 0 X where X is the byte received in error. 
     733// If bit stripping is enabled, a valid 0377 byte is passed as the two-byte 
     734// sequence 0377 0377. 
    735735bool SerialPortImplWin32::getParityErrorMarkingState() const 
    736736{ 

  • juggler/branches/2.2/modules/vapor/vpr/md/WIN32/IO/Port/SerialPortImplWin32.h

    r20268 r20996  
    672672    * BREAKs).  This is only active if input parity and framing error 
    673673    * reporting is enabled (see setInputParityCheck() for more 
    674     * information).  The mark is the three-byte sequence \377 \0 X where X 
     674    * information).  The mark is the three-byte sequence 0377 0 X where X 
    675675    * is the byte received in error.  If bit stripping is enabled, a valid 
    676     * \377 byte is passed as the two-byte sequence \377 \377. 
     676    * 0377 byte is passed as the two-byte sequence 0377 0377. 
    677677    * 
    678678    * @pre This serial port is open. 
    …… 
    682682    * 
    683683    * @see setInputParityCheck 
     684    * 
     685    * @note 0377 == 0xFF == 255 
    684686    */ 
    685687   void setParityErrorMarking(bool flag); 

  • juggler/branches/2.2/modules/vapor/vpr/md/WIN32/Thread/ThreadWin32.h

    r19729 r20996  
    4646 
    4747#include <process.h> 
     48#include <boost/concept_check.hpp> 
    4849 
    4950// To get the Win32 key stuff for storing self. 
    …… 
    100101               VPRThreadScope scope = VPR_GLOBAL_THREAD, 
    101102               VPRThreadState state = VPR_JOINABLE_THREAD, 
    102                size_t stack_size = 0); 
     103               size_t stackSize = 0); 
    103104 
    104105   /** 
    …… 
    281282    * @note This method does nothing. Use kill() instead. 
    282283    */ 
    283    virtual void kill(const int) 
    284    { 
     284   virtual void kill(const int signum) 
     285   { 
     286      boost::ignore_unused_variable_warning(signum); 
    285287      std::cerr << "vpr::ThreadWin32::kill() is not implemented!" 
    286288                << std::endl;