| \anchor ZIP PKWARE ZIP |
ZIP File Format Specification
diff --git a/src/Conf.cpp b/src/Conf.cpp
index 92bb2cef6..0615af863 100644
--- a/src/Conf.cpp
+++ b/src/Conf.cpp
@@ -35,7 +35,7 @@ Conf* Conf::INSTANCE = nullptr;
/**
* @typedef digidoc::ConfCurrent
- * @see digidoc::ConfV5
+ * Reference to latest ConfV5 class.
*/
/**
diff --git a/src/Container.cpp b/src/Container.cpp
index 8592a5d35..1abf0a267 100644
--- a/src/Container.cpp
+++ b/src/Container.cpp
@@ -68,19 +68,14 @@ namespace digidoc
static string m_appName = "libdigidocpp";
static string m_userAgent = "libdigidocpp";
static vector m_createList {};
-using OpenCB = std::unique_ptr (*)(const std::string &path, ContainerOpenCB *cb);
-static vector m_openList {};
+static vector (*)(const std::string &path, ContainerOpenCB *cb)> m_openList {};
}
/**
- * @class digidoc::Container
- * @brief Offers functionality for handling data files and signatures in a container.
+ * @typedef initCallBack
+ * @param e digidoc::Exception that occured on initialization
*
- * Container can contain several files and all these files can be signed using
- * signing certificates. Container can only be signed if it contains data files.
- * data files can be added and removed from container only if the container is
- * not signed. To add or remove data files from signed container remove all the
- * signatures before modifying data files list in container.
+ * Used in digidoc::initialize to notfiy if the initalization has completed
*/
/**
@@ -197,6 +192,35 @@ void digidoc::terminate()
m_userAgent.clear();
}
+/**
+ * @struct digidoc::ContainerOpenCB
+ * @brief Used on container open to provide additional info.
+ *
+ * ContainerOpenCB struct is used on
+ * digidoc::Container::openPtr(const std::string &path, digidoc::ContainerOpenCB *cb)
+ * when additional info is requested.
+ */
+
+/**
+ * @fn digidoc::ContainerOpenCB::validateOnline
+ * Called when requested access online resources.
+ */
+/**
+ * @fn digidoc::ContainerOpenCB::~ContainerOpenCB
+ * Releases resources.
+ */
+
+/**
+ * @class digidoc::Container
+ * @brief Offers functionality for handling data files and signatures in a container.
+ *
+ * Container can contain several files and all these files can be signed using
+ * signing certificates. Container can only be signed if it contains data files.
+ * data files can be added and removed from container only if the container is
+ * not signed. To add or remove data files from signed container remove all the
+ * signatures before modifying data files list in container.
+ */
+
/**
* Create a new container object and specify the DigiDoc container type
*/
@@ -261,7 +285,7 @@ void Container::addDataFile(unique_ptr /*is*/, const string & /*fileNam
*/
void Container::addAdESSignature(const std::vector &signature)
{
- stringstream s(string(signature.begin(), signature.end()));
+ stringstream s({signature.begin(), signature.end()});
addAdESSignature(s);
}
@@ -350,7 +374,7 @@ unique_ptr Container::openPtr(const string &path)
* Opens container from a file
*
* @param path
- * @param cb Callback called when needed
+ * @param cb Callback called when additional info is requested (digidoc::ContainerOpenCB::validateOnline)
* @throws Exception
*/
unique_ptr Container::openPtr(const string &path, ContainerOpenCB *cb)
diff --git a/src/DataFile.cpp b/src/DataFile.cpp
index 1e0cb3032..d363f50e7 100644
--- a/src/DataFile.cpp
+++ b/src/DataFile.cpp
@@ -51,7 +51,7 @@ using namespace std;
* In case of DDoc files, the parameter is ignored and SHA1 hash is always returned
*
* @param method method uri for calculating digest.
- * @return returns calculated digest.
+ * @return returns calculated digest value.
* @throws Exception throws exception if the file does not exist or digest calculation fails.
*/
/**
@@ -115,7 +115,7 @@ vector DataFilePrivate::calcDigest(const string &method) const
void DataFilePrivate::saveAs(const string& path) const
{
- ofstream ofs(File::encodeName(path).c_str(), ofstream::binary);
+ ofstream ofs(File::encodeName(path), ofstream::binary);
saveAs(ofs);
}
diff --git a/src/XmlConf.cpp b/src/XmlConf.cpp
index 81631a8b4..bc8aba641 100644
--- a/src/XmlConf.cpp
+++ b/src/XmlConf.cpp
@@ -265,7 +265,7 @@ void XmlConf::Private::setUserConf(XmlConfParam ¶m, A &&defined, const A
/**
* @typedef digidoc::XmlConfCurrent
- * @see digidoc::XmlConfV5
+ * Reference to latest XmlConfV5 class
*/
/**
|