From 53870a550ac514797e843fb6a61065f272855549 Mon Sep 17 00:00:00 2001
From: K Shiva Kiran <shiva_kr@riseup.net>
Date: Wed, 1 May 2024 11:41:26 +0530
Subject: [PATCH] Bump version, enable documentation of features in docs.rs

---
 Cargo.toml    | 6 +++++-
 src/encode.rs | 8 ++++----
 src/lib.rs    | 4 ++--
 3 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 8727dcd..8fc75b2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "false-bottom"
-version = "0.3.0"
+version = "0.3.1"
 description = "A deniable encryption scheme"
 repository = "https://codeberg.org/skran/false-bottom"
 authors = ["K Shiva Kiran <shiva_kr@riseup.net>"]
@@ -25,3 +25,7 @@ harness = false
 [[example]]
 name = "export"
 required-features = ["base64"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
\ No newline at end of file
diff --git a/src/encode.rs b/src/encode.rs
index 52311d8..56e2fb1 100644
--- a/src/encode.rs
+++ b/src/encode.rs
@@ -21,7 +21,7 @@ pub trait Encode {
 
 	/// Returns the base64 encoded representation of the ciphertext and keybase.  
 	/// Requires `base64` feature to be enabled.
-	#[cfg(feature = "base64")]
+	#[cfg_attr(docsrs, doc(cfg(feature = "base64")))]
 	fn to_base64(&self) -> (String, String);
 
 	/// Constructs the `FbObj` from the provided base64 encoded forms of
@@ -30,7 +30,7 @@ pub trait Encode {
 	/// # Errors
 	/// - [DecodeError](FbError::DecodeError)
 	/// - [InvalidParams](FbError::InvalidParams) - Are the parameters in the wrong order?
-	#[cfg(feature = "base64")]
+	#[cfg_attr(docsrs, doc(cfg(feature = "base64")))]	
 	fn from_base64(cipher: &str, keybase: &str) -> Result<Self, FbError>
 	where
 		Self: Sized;
@@ -68,14 +68,14 @@ where
 		Ok(FbObj {c, r})
 	}
 
-	#[cfg(feature = "base64")]
+	#[cfg_attr(docsrs, doc(cfg(feature = "base64")))]	
 	fn to_base64(&self) -> (String, String) {
 		let (c, r) = self.to_bytes();
 
 		(BASE64_STANDARD.encode(c), BASE64_STANDARD.encode(r))
 	}
 
-	#[cfg(feature = "base64")]
+	#[cfg_attr(docsrs, doc(cfg(feature = "base64")))]	
 	fn from_base64(cipher: &str, keybase: &str) -> Result<Self, FbError> {
 		let c_bytes = BASE64_STANDARD.decode(cipher)
 			.map_err(|_| FbError::DecodeError)?;
diff --git a/src/lib.rs b/src/lib.rs
index fa14f80..e2577e1 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,5 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
+#![cfg_attr(docsrs, feature(doc_cfg))]
 //! ## Usage
 //! False Bottom is a [deniable encryption](https://en.wikipedia.org/wiki/Deniable_encryption) scheme.  
 //! Unlike traditional encryption algorithms that map a given plaintext to ciphertext,
@@ -83,13 +84,12 @@ mod packing;
 pub use crate::{
 	encode::Encode,
 	falsebottom::FalseBottom,
-	fbobj::{Fb128, Fb256, Fb512},
+	fbobj::{Fb128, Fb256, Fb512, FbObj},
 	fbkey::FbKey,
 	fberror::FbError,
 };
 
 use crate::{
-	fbobj::FbObj,
 	packing::Packing,
 	primefield::PrimeField,
 };