Diffstat (limited to 'public/include/XMP.hpp')
1 files changed, 18 insertions, 18 deletions
diff --git a/public/include/XMP.hpp b/public/include/XMP.hpp
index 2ceb936..62e230d 100644
@@ -11,16 +11,16 @@
/// \file XMP.hpp
-/// \brief Overall header file for the XMP toolkit.
+/// \brief Overall header file for the XMP Toolkit
-/// This is an overall header file, the only one that C++ clients should #include. The full client
-/// API is in the \c TXMPMeta.hpp, \c TXMPIterator.hpp, \c TXMPUtils.hpp headers. Read these for
-/// information, but do not #include them directly. The \c TXMP... classes are C++ template classes
-/// that must be instantiated with a string class such as <tt>std::string<\tt>. The string class is
-/// used to return text strings for property values, serialized XMP, etc.
+/// This is an overall header file, the only one that C++ clients should include.
-/// Clients must also compile <tt>XMP.incl_cpp<\tt> to ensure that all client-side glue code is
-/// generated. This should be done by #including it in exactly one client source file.
+/// The full client API is in the \c TXMPMeta.hpp, \c TXMPIterator.hpp, \c TXMPUtils.hpp headers.
+/// Read these for information, but do not include them directly. The \c TXMP... classes are C++
+/// template classes that must be instantiated with a string class such as \c std::string. The
+/// string class is used to return text strings for property values, serialized XMP, and so on.
+/// Clients must also compile \c XMP.incl_cpp to ensure that all client-side glue code is generated.
+/// This should be done by including it in exactly one client source file.
/// There are two C preprocessor macros that simplify use of the templates:
@@ -29,24 +29,27 @@
/// \li \c TXMP_EXPAND_INLINE - Define this as 1 if you want to have the template functions expanded
/// inline in your code. Leave it undefined, or defined as 0, to use out-of-line instantiations of
-/// the template functions. Compiling <tt>XMP.incl_cpp<\tt> generates explicit out-of-line
+/// the template functions. Compiling \c XMP.incl_cpp generates explicit out-of-line
/// instantiations if \c TXMP_EXPAND_INLINE is off.
-/// The template parameter, class \c tStringObj, must have the following member functions (which match
-/// those for <tt>std::string<\tt>):
+/// The template parameter, class \c tStringObj, must have the following member functions (which
+/// match those for \c std::string):
/// tStringObj& assign ( const char * str, size_t len )
/// size_t size() const
/// const char * c_str() const
/// The string class must be suitable for at least UTF-8. This is the encoding used for all general
/// values, and is the default encoding for serialized XMP. The string type must also be suitable
/// for UTF-16 or UTF-32 if those serialization encodings are used. This mainly means tolerating
-/// embedded 0 bytes, which std::string does.
+/// embedded 0 bytes, which \c std::string does.
+/// /c XMP_Environment.h must be the first included header.
-#include "XMP_Environment.h" // ! This must be the first include!
@@ -65,11 +68,9 @@
typedef class TXMPMeta <TXMP_STRING_TYPE> SXMPMeta; // For client convenience.
typedef class TXMPIterator <TXMP_STRING_TYPE> SXMPIterator;
typedef class TXMPUtils <TXMP_STRING_TYPE> SXMPUtils;
#error "TXMP_EXPAND_INLINE is not working at present. Please don't use it."
@@ -92,7 +93,6 @@
#pragma warning ( pop )
#endif // __XMP_hpp__