improved doxygen

This commit is contained in:
Marc Wäckerlin
2009-09-18 11:41:30 +00:00
parent 2ae49d2cd5
commit d5548a3f13
5 changed files with 95 additions and 4 deletions

View File

@@ -49,8 +49,10 @@
#include <sstream>
#include <iomanip>
//! This library is a C++ wrapper to the awful pcsc-lite interface.
/*! The reason for this wrapper is to get a nice object oriented
/*! @defgroup gpcsc C++ Wrapper around pcsc-lite API
This library is a C++ wrapper to the awful pcsc-lite interface.
The reason for this wrapper is to get a nice object oriented
interface written in C++ manner and using standard types and so to
avoid the ugly M$-C-quirks. This interface is memory clean.
@todo: Not implemented, not supported:
@@ -64,8 +66,17 @@
required. If you need something that is not yet supported, please
let me know, what you need and why. Then I'll add it so that it
best fits the common needs. */
//@{
/*! @defgroup pcsclib PCSC C++ Library */
/*! @defgroup pcsctypes PCSC Types and Auxiliary */
/*! @defgroup pcscexceptions PCSC Exceptions */
//! @see gpcsc
namespace pcsc {
//! @addtogroup pcsctypes
//@{
std::string hex(const std::string& data) {
std::stringstream res;
for (std::string::const_iterator it(data.begin()); it!=data.end(); ++it)
@@ -74,7 +85,13 @@ namespace pcsc {
return res.str();
}
//@}
//============================================================================
//! @addtogroup pcsclib
//@{
//----------------------------------------------------------------------------
class exception: public std::exception {
public:
exception(const std::string& reason) throw(): _what("pcsc: "+reason) {}
@@ -99,7 +116,11 @@ namespace pcsc {
exception("smardcard access error:\n"+reason) {
}
};
//@}
//! @addtogroup pcsclib
//@{
//============================================================================
class Connection {
@@ -695,5 +716,9 @@ namespace pcsc {
};
//@}
}
//@}
#endif