From: Fred Morcos Date: Fri, 10 Feb 2023 14:51:06 +0000 (+0100) Subject: Documentation formatting and ordering for createFromPEMFile X-Git-Tag: dnsdist-1.8.0-rc1~18^2~3 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a538f953fb7b07df90124839b76760b44d40e759;p=thirdparty%2Fpdns.git Documentation formatting and ordering for createFromPEMFile --- diff --git a/pdns/decafsigners.cc b/pdns/decafsigners.cc index 2c6af8bd81..c00f2f8762 100644 --- a/pdns/decafsigners.cc +++ b/pdns/decafsigners.cc @@ -26,19 +26,15 @@ public: /** * \brief Creates an ED25519 key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an - * ED25519 key engine. + * Receives an open file handle with PEM contents and creates an ED25519 key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information in - * error messages. + * \param[in] inputFile An open file handle to a file containing ED25519 PEM contents. * - * \param[in] inputFile An open file handle to a file containing ED25519 PEM - * contents. + * \param[in] filename Only used for providing filename information in error messages. * - * \return An ED25519 key engine populated with the contents of the - * PEM file. + * \return An ED25519 key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override; @@ -224,19 +220,15 @@ public: /** * \brief Creates an ED448 key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an ED448 - * key engine. + * Receives an open file handle with PEM contents and creates an ED448 key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information in - * error messages. + * \param[in] inputFile An open file handle to a file containing ED448 PEM contents. * - * \param[in] inputFile An open file handle to a file containing ED448 PEM - * contents. + * \param[in] filename Only used for providing filename information in error messages. * - * \return An ED448 key engine populated with the contents of the PEM - * file. + * \return An ED448 key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override; diff --git a/pdns/opensslsigners.cc b/pdns/opensslsigners.cc index 4b2ef8be7a..3586ea261b 100644 --- a/pdns/opensslsigners.cc +++ b/pdns/opensslsigners.cc @@ -215,16 +215,14 @@ public: /** * \brief Creates an RSA key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an RSA key - * engine. + * Receives an open file handle with PEM contents and creates an RSA key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information in error - * messages. - * * \param[in] inputFile An open file handle to a file containing RSA PEM contents. * + * \param[in] filename Only used for providing filename information in error messages. + * * \return An RSA key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override; @@ -999,19 +997,15 @@ public: /** * \brief Creates an ECDSA key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an ECDSA - * key engine. + * Receives an open file handle with PEM contents and creates an ECDSA key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information - * in error messages. + * \param[in] inputFile An open file handle to a file containing ECDSA PEM contents. * - * \param[in] inputFile An open file handle to a file containing ECDSA PEM - * contents. + * \param[in] filename Only used for providing filename information in error messages. * - * \return An ECDSA key engine populated with the contents of the PEM - * file. + * \return An ECDSA key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override; @@ -1754,19 +1748,15 @@ public: /** * \brief Creates an EDDSA key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an EDDSA - * key engine. + * Receives an open file handle with PEM contents and creates an EDDSA key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information in - * error messages. + * \param[in] inputFile An open file handle to a file containing EDDSA PEM contents. * - * \param[in] inputFile An open file handle to a file containing EDDSA PEM - * contents. + * \param[in] filename Only used for providing filename information in error messages. * - * \return An EDDSA key engine populated with the contents of the PEM - * file. + * \return An EDDSA key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override; diff --git a/pdns/sodiumsigners.cc b/pdns/sodiumsigners.cc index 623d3290ff..d662eaa3b1 100644 --- a/pdns/sodiumsigners.cc +++ b/pdns/sodiumsigners.cc @@ -23,19 +23,15 @@ public: /** * \brief Creates an ED25519 key engine from a PEM file. * - * Receives an open file handle with PEM contents and creates an - * ED25519 key engine. + * Receives an open file handle with PEM contents and creates an ED25519 key engine. * * \param[in] drc Key record contents to be populated. * - * \param[in] filename Only used for providing filename information in - * error messages. + * \param[in] inputFile An open file handle to a file containing ED25519 PEM contents. * - * \param[in] inputFile An open file handle to a file containing ED25519 PEM - * contents. + * \param[in] filename Only used for providing filename information in error messages. * - * \return An ED25519 key engine populated with the contents of the - * PEM file. + * \return An ED25519 key engine populated with the contents of the PEM file. */ void createFromPEMFile(DNSKEYRecordContent& drc, std::FILE& inputFile, const std::string& filename) override;