aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteven Fackler <[email protected]>2018-01-06 21:51:08 -0800
committerGitHub <[email protected]>2018-01-06 21:51:08 -0800
commitdb2b8bbc78357aa611be957e4d0556e8cfa088c5 (patch)
tree38ab5eac0976107a731903a911273378c8dd1877
parentMerge pull request #821 from sfackler/rsa-accessors (diff)
parentFix docs (diff)
downloadrust-openssl-db2b8bbc78357aa611be957e4d0556e8cfa088c5.tar.xz
rust-openssl-db2b8bbc78357aa611be957e4d0556e8cfa088c5.zip
Merge pull request #822 from sfackler/doc-fixes
Fix docs
-rw-r--r--openssl/src/bn.rs5
-rw-r--r--openssl/src/ssl/mod.rs4
2 files changed, 6 insertions, 3 deletions
diff --git a/openssl/src/bn.rs b/openssl/src/bn.rs
index 25dae93d..fe662e85 100644
--- a/openssl/src/bn.rs
+++ b/openssl/src/bn.rs
@@ -12,16 +12,17 @@
//! use openssl::bn::BigNum;
//! use openssl::error::ErrorStack;
//!
-//! fn bignums() -> Result< (), ErrorStack > {
+//! fn bignums() -> Result<(), ErrorStack> {
//! let a = BigNum::new()?; // a = 0
//! let b = BigNum::from_dec_str("1234567890123456789012345")?;
//! let c = &a * &b;
-//! assert_eq!(a,c);
+//! assert_eq!(a, c);
//! Ok(())
//! }
//! # fn main() {
//! # bignums();
//! # }
+//! ```
//!
//! [`BIGNUM`]: https://wiki.openssl.org/index.php/Manual:Bn_internal(3)
use ffi;
diff --git a/openssl/src/ssl/mod.rs b/openssl/src/ssl/mod.rs
index 9175bcf0..0384ca1e 100644
--- a/openssl/src/ssl/mod.rs
+++ b/openssl/src/ssl/mod.rs
@@ -2247,7 +2247,9 @@ impl<S: Read + Write> SslStream<S> {
/// session down. In particular, it must be fully shut down if the connection is to be used for
/// further communication in the future.
///
- /// This corresponds to [`SSL_shutdown`]: https://www.openssl.org/docs/man1.0.2/ssl/SSL_shutdown.html
+ /// This corresponds to [`SSL_shutdown`].
+ ///
+ /// [`SSL_shutdown`]: https://www.openssl.org/docs/man1.0.2/ssl/SSL_shutdown.html
pub fn shutdown(&mut self) -> Result<ShutdownResult, Error> {
match unsafe { ffi::SSL_shutdown(self.ssl.as_ptr()) } {
0 => Ok(ShutdownResult::Sent),