Update documentation

src/Conf.cpp

@@ -42,7 +42,7 @@ Conf* Conf::INSTANCE = nullptr;
  * @class digidoc::Conf
  * @brief Configuration class which can reimplemented and virtual methods overloaded.
  *
- * @deprecated Use digidoc::ConfV5
+ * @deprecated Since 3.12.2, use digidoc::ConfV5
  * @see @ref parameters
  */
 /**
@@ -68,7 +68,7 @@ void Conf::init(Conf *conf)
 
 /**
  * Returns libdigidoc library configuration file's (digidoc.ini) file location
- * @deprecated Unused
+ * @deprecated Since 3.12.0, Unused
  */
 string Conf::libdigidocConf() const { return {}; }
 
@@ -118,7 +118,7 @@ string Conf::ocsp(const string &/*issuer*/) const
 
 /**
  * Gets Certificate store location.
- * @deprecated Unused
+ * @deprecated Since 3.10.0, Unused
  */
 string Conf::certsPath() const { return {}; }
 
@@ -146,17 +146,20 @@ string Conf::proxyPass() const { return {}; }
  * Gets PKCS12 certificate file location.
  *
  * Used for signing OCSP request
+ * @deprecated Since 3.16.0
  */
 string Conf::PKCS12Cert() const { return {}; }
 
 /**
  * Gets PKCS12 password.
+ * @deprecated Since 3.16.0
  * @see digidoc::Conf::PKCS12Cert
  */
 string Conf::PKCS12Pass() const { return {}; }
 
 /**
  * Gets PKCS12 usage.
+ * @deprecated Since 3.16.0
  * @see digidoc::Conf::PKCS12Cert
  */
 bool Conf::PKCS12Disable() const { return false; }
@@ -235,8 +238,9 @@ string Conf::verifyServiceUri() const { return SIVA_URL; }
  * Conf contains virtual members and is not leaf class we need create
  * subclasses to keep binary compatibility
  * https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C++#Adding_new_virtual_functions_to_leaf_classes
+ * @since 3.12.2
  * @see digidoc::Conf
- * @deprecated Use digidoc::ConfV5
+ * @deprecated Since 3.13.8, use digidoc::ConfV5
  * @see @ref parameters
  */
 /**
@@ -253,6 +257,7 @@ ConfV2* ConfV2::instance() { return dynamic_cast<ConfV2*>(Conf::instance()); }
 
 /**
  * Gets verify service Cert
+ * @since 3.12.2
  */
 X509Cert ConfV2::verifyServiceCert() const { return X509Cert(); }
 
@@ -265,8 +270,9 @@ X509Cert ConfV2::verifyServiceCert() const { return X509Cert(); }
  * Conf contains virtual members and is not leaf class we need create
  * subclasses to keep binary compatibility
  * https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C++#Adding_new_virtual_functions_to_leaf_classes
+ * @since 3.13.8
  * @see digidoc::ConfV2
- * @deprecated Use digidoc::ConfV5
+ * @deprecated Since 3.14.7, use digidoc::ConfV5
  * @see @ref parameters
  */
 /**
@@ -285,6 +291,7 @@ ConfV3* ConfV3::instance() { return dynamic_cast<ConfV3*>(Conf::instance()); }
  * Gets OCSP TM Profile OID-s
  *
  * OCSP responder certificate policies that are used to identify if OCSP response is given with TM profile
+ * @since 3.13.8
  */
 set<string> ConfV3::OCSPTMProfiles() const { return { "1.3.6.1.4.1.10015.4.1.2" }; }
 
@@ -297,8 +304,9 @@ set<string> ConfV3::OCSPTMProfiles() const { return { "1.3.6.1.4.1.10015.4.1.2"
  * Conf contains virtual members and is not leaf class we need create
  * subclasses to keep binary compatibility
  * https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C++#Adding_new_virtual_functions_to_leaf_classes
+ * @since 3.14.7
  * @see digidoc::ConfV3
- * @deprecated Use digidoc::ConfV5
+ * @deprecated Since 3.15.0, use digidoc::ConfV5
  * @see @ref parameters
  */
 /**
@@ -315,6 +323,7 @@ ConfV4* ConfV4::instance() { return dynamic_cast<ConfV4*>(Conf::instance()); }
 
 /**
  * Gets verify service Certs
+ * @since 3.14.7
  */
 vector<X509Cert> ConfV4::verifyServiceCerts() const
 {
@@ -330,6 +339,7 @@ vector<X509Cert> ConfV4::verifyServiceCerts() const
  * Conf contains virtual members and is not leaf class we need create
  * subclasses to keep binary compatibility
  * https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C++#Adding_new_virtual_functions_to_leaf_classes
+ * @since 3.15.0
  * @see digidoc::ConfV4
  * @see @ref parameters
  */
@@ -347,6 +357,7 @@ ConfV5* ConfV5::instance() { return dynamic_cast<ConfV5*>(Conf::instance()); }
 
 /**
  * Gets verify service Certs
+ * @since 3.15.0
  */
 vector<X509Cert> ConfV5::TSCerts() const
 {

src/Container.cpp

@@ -66,6 +66,7 @@ string digidoc::appInfo() { return m_appName; }
 
 /**
  * Returns user-agent info
+ * @since 3.14.3
  */
 string digidoc::userAgent() { return m_userAgent; }
 
@@ -94,6 +95,7 @@ void digidoc::initialize(const string &appInfo, initCallBack callBack)
  * loads configuration settings from default configuration files (see \ref conf) and initializes
  * certificate store using TSL lists
  *
+ * @since 3.14.3
  * @param appInfo Application name for container comments
  * @param userAgent Application info for user agent string
  * @param callBack Callback when background thread TSL loading is completed
@@ -231,7 +233,7 @@ Container::~Container() = default;
  * Adds the data from an input stream (i.e. the data file contents can be read from internal memory buffer).
  *
  * Takes ownership std::istream *is object.
- * @deprecated Use digidoc::Container::addDataFile(std::unique_ptr<std::istream> is, const std::string &fileName, const std::string &mediaType)
+ * @deprecated Since 3.14.4, use digidoc::Container::addDataFile(std::unique_ptr<std::istream> is, const std::string &fileName, const std::string &mediaType)
  * @param is input stream from where data is read
  * @param fileName data file name in the container
  * @param mediaType MIME type of the data file, for example “text/plain” or “application/msword”
@@ -248,6 +250,7 @@ void Container::addDataFile(istream *is, const string &fileName, const string &m
 /**
  * Adds the data from an input stream (i.e. the data file contents can be read from internal memory buffer).
  *
+ * @since 3.14.4
  * @param is input stream from where data is read
  * @param fileName data file name in the container
  * @param mediaType MIME type of the data file, for example “text/plain” or “application/msword”
@@ -284,7 +287,7 @@ void Container::addAdESSignature(const std::vector<unsigned char> &signature)
 /**
  * Create a new container object and specify the DigiDoc container type
  *
- * @deprecated Use Container::createPtr
+ * @deprecated Since 3.14.4, use Container::createPtr
  * This method gives ownership of object to caller
  */
 Container* Container::create(const std::string &path)
@@ -294,6 +297,7 @@ Container* Container::create(const std::string &path)
 
 /**
  * Create a new container object and specify the DigiDoc container type
+ * @since 3.14.4
  */
 unique_ptr<Container> Container::createPtr(const std::string &path)
 {
@@ -334,7 +338,7 @@ unsigned int Container::newSignatureId() const
  *
  * This method gives ownership of object to caller
  *
- * @deprecated Use Container::openPtr
+ * @deprecated Since 3.14.4, use Container::openPtr
  * @param path
  * @throws Exception
  */
@@ -346,6 +350,7 @@ Container* Container::open(const string &path)
 /**
  * Opens container from a file
  *
+ * @since 3.14.4
  * @param path
  * @throws Exception
  */
@@ -357,6 +362,7 @@ unique_ptr<Container> Container::openPtr(const string &path)
 /**
  * Opens container from a file
  *
+ * @since 3.17.0
  * @param path
  * @param cb Callback called when additional info is requested (digidoc::ContainerOpenCB::validateOnline)
  * @throws Exception

src/Exception.cpp

@@ -44,10 +44,13 @@ std::vector<Exception::ExceptionCode> Exception::ignores {};
  * General error, no specific code
  * @var digidoc::Exception::NetworkError
  * Network error, network connection errors
+ * @since 3.14.3
  * @var digidoc::Exception::HostNotFound
  * Network error, host not found
+ * @since 3.14.8
  * @var digidoc::Exception::InvalidUrl
  * Network error, invalid URL
+ * @since 3.14.8
  *
  * @var digidoc::Exception::CertificateIssuerMissing
  * Signer's certificate's issuer certificate is missing
@@ -57,6 +60,7 @@ std::vector<Exception::ExceptionCode> Exception::ignores {};
  * Certificate status is unknown in OCSP response
  * @var digidoc::Exception::OCSPBeforeTimeStamp
  * OCSP producedAt time is before TimeStamp time
+ * @since 3.14.2
  * @var digidoc::Exception::OCSPResponderMissing
  * OCSP Responder is missing
  * @var digidoc::Exception::OCSPCertMissing
@@ -67,8 +71,10 @@ std::vector<Exception::ExceptionCode> Exception::ignores {};
  * OCSP Responder requires the OCSP request to be signed
  * @var digidoc::Exception::TSForbidden
  * TSA service responds forbidden
+ * @since 3.14.4
  * @var digidoc::Exception::TSTooManyRequests
  * TSA service requests have reached limit
+ * @since 3.13.8
  *
  * @var digidoc::Exception::PINCanceled
  * PIN cancelled exception
@@ -91,10 +97,11 @@ std::vector<Exception::ExceptionCode> Exception::ignores {};
  * TimeStamp and OCSP time difference is more than 15 minutes
  * @var digidoc::Exception::MimeTypeWarning
  * Mime type is not conformant mime-type strings
+ * @since 3.13.2
  *
  * @var digidoc::Exception::DDocError
  * DDoc libdigidoc error codes bit masked
- * @deprecated Unused
+ * @deprecated Since 3.14.7, libdigidoc support removed
  */
 
 /**