Changeset 10712 for trunk/FACT++

Timestamp:

05/13/11 20:03:59 (14 years ago)

Author:

tbretz

Message:

Some fixed to the doxygen docu

Location:

trunk/FACT++/src

Files:

• Converter.h (modified) (1 diff)
• Dim.h (modified) (1 diff)
• FACT.cc (modified) (3 diffs)
• MessageImp.h (modified) (1 diff)
• StateMachineImp.h (modified) (1 diff)

trunk/FACT++/src/Converter.h

@@ -144 +144 @@
 
 // ***************************************************************************
-/** @fn GetHex(const void *dat, size_t size, size_t col, bool prefix)
+/** @template GetHex(const void *dat, size_t size, size_t col, bool prefix)
 
 Converts from a binary block into a hex representation.

trunk/FACT++/src/Dim.h

@@ -44 +44 @@
     //!     set to &t
     //!
-    //! @template T
+    //! @tparam T
     //!     type of the data to be sent. The size of the data to be sent
     //!     is determined as sizeof(T)

trunk/FACT++/src/FACT.cc

@@ -21 +21 @@
 //! of the following formats:
 //!
+//! \verbatim
 //!  - <version>
 //!  - <program> <version>
@@ -26 +27 @@
 //!  - <program> ({GNU,Free} <package>) <version>
 //!  - <program> - {GNU,Free} <package> <version>
+//! \endverbatim
 //!
 //!  and separated from any copyright/author details by a blank line.
@@ -31 +33 @@
 //! Handle multi-line bug reporting sections of the form:
 //!
+//! \verbatim
 //!  - Report <program> bugs to <addr>
 //!  - GNU <package> home page: <url>
 //!  - ...
-//!
+//! \endverbatim
 //!
 //! @param name

trunk/FACT++/src/MessageImp.h

@@ -32 +32 @@
     virtual int Write(const Time &time, const std::string &txt, int qos=kInfo);
 
-    int Update(const std::string &str, int qos=kInfo);
-    int Update(const char *txt, int qos=kInfo) { return Update(std::string(txt), qos); }
-    int Update(const std::stringstream &str, int qos=kInfo) { return Update(str.str(), qos); }
+    int Update(const std::string &txt, int severity=kInfo);
+    int Update(const char *txt, int severity=kInfo) { return Update(std::string(txt), severity); }
+    int Update(const std::stringstream &str, int severity=kInfo) { return Update(str.str(), severity); }
 //    int Update(int qos, const char *fmt, ...);
 

trunk/FACT++/src/StateMachineImp.h

@@ -122 +122 @@
 
     void PrintListOfEvents(std::ostream &out, const std::string &evt="") const;
-    void PrintListOfEvents(const std::string &evt="") const;
+    void PrintListOfEvents(const std::string &str="") const;
 
     void PrintListOfStates(std::ostream &out) const;