Change to doxygen comments
diff --git a/ndn-cpp/encoding/BinaryXMLStructureDecoder.h b/ndn-cpp/encoding/BinaryXMLStructureDecoder.h
index 40ac782..ad10fcf 100644
--- a/ndn-cpp/encoding/BinaryXMLStructureDecoder.h
+++ b/ndn-cpp/encoding/BinaryXMLStructureDecoder.h
@@ -12,12 +12,12 @@
#endif
struct ndn_BinaryXMLStructureDecoder {
- int gotElementEnd; // boolean
+ int gotElementEnd; /**< boolean */
unsigned int offset;
int level;
int state;
unsigned int headerLength;
- int useHeaderBuffer; // boolean
+ int useHeaderBuffer; /**< boolean */
// 10 bytes is enough to hold an encoded header with a type and a 64 bit value.
unsigned char headerBuffer[10];
int nBytesToRead;
diff --git a/ndn-cpp/encoding/BinaryXMLStructureDecoder.hpp b/ndn-cpp/encoding/BinaryXMLStructureDecoder.hpp
index 5d4931d..d7cc9c7 100644
--- a/ndn-cpp/encoding/BinaryXMLStructureDecoder.hpp
+++ b/ndn-cpp/encoding/BinaryXMLStructureDecoder.hpp
@@ -10,6 +10,11 @@
#include "BinaryXMLStructureDecoder.h"
namespace ndn {
+
+/**
+ * A BinaryXMLStructureDecoder wraps a C struct ndn_BinaryXMLStructureDecoder and
+ * related functions.
+ */
class BinaryXMLStructureDecoder {
public:
BinaryXMLStructureDecoder() {
@@ -19,6 +24,7 @@
private:
struct ndn_BinaryXMLStructureDecoder base;
};
+
}
#endif /* BINARYXMLSTRUCTUREDECODER_HPP */