Replacing (C-not exported) in the docs

Replaced with (This is not exported to bindings users)
and also added new line in docs with /// and a new line
separating it in the code.

Author: munjesi

lightning-background-processor/src/lib.rs

@@ -163,8 +163,9 @@ where U::Target: UtxoLookup, L::Target: Logger {
 		}
 	}
 }
+///
 
-// (C-not exported) as the bindings concretize everything and have constructors for us
+/// (This is not exported to bindings users) as the bindings concretize everything and have constructors for us
 impl<P: Deref<Target = P2PGossipSync<G, U, L>>, G: Deref<Target = NetworkGraph<L>>, U: Deref, L: Deref>
 	GossipSync<P, &RapidGossipSync<G, L>, G, U, L>
 where
@@ -176,8 +177,9 @@ where
 		GossipSync::P2P(gossip_sync)
 	}
 }
+///
 
-// (C-not exported) as the bindings concretize everything and have constructors for us
+/// (This is not exported to bindings users) as the bindings concretize everything and have constructors for us
 impl<'a, R: Deref<Target = RapidGossipSync<G, L>>, G: Deref<Target = NetworkGraph<L>>, L: Deref>
 	GossipSync<
 		&P2PGossipSync<G, &'a (dyn UtxoLookup + Send + Sync), L>,
@@ -194,8 +196,9 @@ where
 		GossipSync::Rapid(gossip_sync)
 	}
 }
+///
 
-// (C-not exported) as the bindings concretize everything and have constructors for us
+/// (This is not exported to bindings users) as the bindings concretize everything and have constructors for us
 impl<'a, L: Deref>
 	GossipSync<
 		&P2PGossipSync<&'a NetworkGraph<L>, &'a (dyn UtxoLookup + Send + Sync), L>,

lightning-invoice/src/lib.rs

@@ -215,8 +215,9 @@ pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
 ///  * `D`: exactly one `Description` or `DescriptionHash`
 ///  * `H`: exactly one `PaymentHash`
 ///  * `T`: the timestamp is set
+///
 
-// (C-not exported) as we likely need to manually select one set of boolean type parameters.
+/// (This is not exported to bindings users) as we likely need to manually select one set of boolean type parameters.
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> {
 	currency: Currency,
@@ -246,9 +247,10 @@ pub struct Invoice {
 
 /// Represents the description of an invoice which has to be either a directly included string or
 /// a hash of a description provided out of band.
+///
 
-// (C-not exported) As we don't have a good way to map the reference lifetimes making this
-// practically impossible to use safely in languages like C.
+/// (This is not exported to bindings users) As we don't have a good way to map the reference lifetimes making this
+/// practically impossible to use safely in languages like C.
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub enum InvoiceDescription<'f> {
 	/// Reference to the directly supplied description in the invoice
@@ -296,8 +298,9 @@ pub struct RawInvoice {
 }
 
 /// Data of the `RawInvoice` that is encoded in the human readable part
+///
 
-// (C-not exported) As we don't yet support `Option<Enum>`
+/// (This is not exported to bindings users) As we don't yet support `Option<Enum>`
 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 pub struct RawHrp {
 	/// The currency deferred from the 3rd and 4th character of the bech32 transaction
@@ -357,8 +360,8 @@ impl SiPrefix {
 	/// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
 	/// multiplier.
 	
-	// (C-not exported) As we don't yet support a slice of enums, and also because this function
-	// isn't the most critical to expose.
+	/// (This is not exported to bindings users) As we don't yet support a slice of enums, and also because this function
+	/// isn't the most critical to expose.
 	pub fn values_desc() -> &'static [SiPrefix] {
 		use crate::SiPrefix::*;
 		static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
@@ -386,8 +389,9 @@ pub enum Currency {
 }
 
 /// Tagged field which may have an unknown tag
+///
 
-// (C-not exported) as we don't currently support TaggedField
+/// (This is not exported to bindings users) as we don't currently support TaggedField
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub enum RawTaggedField {
 	/// Parsed tagged field with known tag
@@ -399,9 +403,10 @@ pub enum RawTaggedField {
 /// Tagged field with known tag
 ///
 /// For descriptions of the enum values please refer to the enclosed type's docs.
+///
 
-// (C-not exported) As we don't yet support enum variants with the same name the struct contained
-// in the variant.
+/// (This is not exported to bindings users) As we don't yet support enum variants with the same name the struct contained
+/// in the variant.
 #[allow(missing_docs)]
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 pub enum TaggedField {
@@ -419,7 +424,7 @@ pub enum TaggedField {
 
 /// SHA-256 hash
 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
-pub struct Sha256(// (C-not exported) as the native hash types are not currently mapped
+pub struct Sha256(/// (This is not exported to bindings users) as the native hash types are not currently mapped
 	pub sha256::Hash);
 
 /// Description string
@@ -873,8 +878,8 @@ impl RawInvoice {
 	/// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
 	/// are no constraints regarding the validity of the produced signature.
 	
-	// (C-not exported) As we don't currently support passing function pointers into methods
-	// explicitly.
+	/// (This is not exported to bindings users) As we don't currently support passing function pointers into methods
+	/// explicitly.
 	pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
 		where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
 	{
@@ -892,7 +897,7 @@ impl RawInvoice {
 
 	/// Returns an iterator over all tagged fields with known semantics.
 	
-	// (C-not exported) As there is not yet a manual mapping for a FilterMap
+	/// (This is not exported to bindings users) As there is not yet a manual mapping for a FilterMap
 	pub fn known_tagged_fields(&self)
 		-> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
 	{
@@ -941,7 +946,7 @@ impl RawInvoice {
 		find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
 	}
 
-	// (C-not exported) as we don't support Vec<&NonOpaqueType>
+	/// (This is not exported to bindings users) as we don't support Vec<&NonOpaqueType>
 	pub fn fallbacks(&self) -> Vec<&Fallback> {
 		find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
 	}
@@ -1170,7 +1175,7 @@ impl Invoice {
 
 	/// Returns an iterator over all tagged fields of this Invoice.
 	
-	// (C-not exported) As there is not yet a manual mapping for a FilterMap
+	/// (This is not exported to bindings users) As there is not yet a manual mapping for a FilterMap
 	pub fn tagged_fields(&self)
 		-> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
 		self.signed_invoice.raw_invoice().known_tagged_fields()
@@ -1183,7 +1188,7 @@ impl Invoice {
 
 	/// Return the description or a hash of it for longer ones
 	
-	// (C-not exported) because we don't yet export InvoiceDescription
+	/// (This is not exported to bindings users) because we don't yet export InvoiceDescription
 	pub fn description(&self) -> InvoiceDescription {
 		if let Some(direct) = self.signed_invoice.description() {
 			return InvoiceDescription::Direct(direct);
@@ -1253,7 +1258,7 @@ impl Invoice {
 
 	/// Returns a list of all fallback addresses
 	
-	// (C-not exported) as we don't support Vec<&NonOpaqueType>
+	/// (This is not exported to bindings users) as we don't support Vec<&NonOpaqueType>
 	pub fn fallbacks(&self) -> Vec<&Fallback> {
 		self.signed_invoice.fallbacks()
 	}

lightning-invoice/src/ser.rs

@@ -123,8 +123,9 @@ impl Display for SignedRawInvoice {
 		Ok(())
 	}
 }
+///
 
-// (C-not exported)
+/// (This is not exported to bindings users)
 impl Display for RawHrp {
 	fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
 		let amount = match self.raw_amount {

lightning-rapid-gossip-sync/src/lib.rs

@@ -146,7 +146,7 @@ impl<NG: Deref<Target=NetworkGraph<L>>, L: Deref> RapidGossipSync<NG, L> where L
 	/// Gets a reference to the underlying [`NetworkGraph`] which was provided in
 	/// [`RapidGossipSync::new`].
 	
-	// (C-not exported) as bindings don't support a reference-to-a-reference yet
+	/// (This is not exported to bindings users) as bindings don't support a reference-to-a-reference yet
 	pub fn network_graph(&self) -> &NG {
 		&self.network_graph
 	}

lightning/src/chain/keysinterface.rs

@@ -54,8 +54,9 @@ use crate::util::invoice::construct_invoice_preimage;
 
 /// Used as initial key material, to be expanded into multiple secret keys (but not to be used
 /// directly). This is used within LDK to encrypt/decrypt inbound payment data.
+///
 
-// (C-not exported) as we just use `[u8; 32]` directly
+/// (This is not exported to bindings users) as we just use `[u8; 32]` directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct KeyMaterial(pub [u8; 32]);
 

lightning/src/chain/transaction.rs

@@ -67,7 +67,8 @@ impl OutPoint {
 
 	/// Converts this OutPoint into the OutPoint field as used by rust-bitcoin
 	
-	// (C-not exported) as the same type is used universally in the C bindings for all outpoints
+	/// (This is not exported to bindings users) as the same type is used universally in the C bindings 
+	/// for all outpoints
 	pub fn into_bitcoin_outpoint(self) -> BitcoinOutPoint {
 		BitcoinOutPoint {
 			txid: self.txid,

lightning/src/ln/chan_utils.rs

@@ -1272,7 +1272,7 @@ impl CommitmentTransaction {
 	///
 	/// Only include HTLCs that are above the dust limit for the channel.
 	
-	// (C-not exported) due to the generic though we likely should expose a version without
+	/// (This is not exported to bindings users) due to the generic though we likely should expose a version without
 	pub fn new_with_auxiliary_htlc_data<T>(commitment_number: u64, to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, opt_anchors: bool, broadcaster_funding_key: PublicKey, countersignatory_funding_key: PublicKey, keys: TxCreationKeys, feerate_per_kw: u32, htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>, channel_parameters: &DirectedChannelTransactionParameters) -> CommitmentTransaction {
 		// Sort outputs and populate output indices while keeping track of the auxiliary data
 		let (outputs, htlcs) = Self::internal_build_outputs(&keys, to_broadcaster_value_sat, to_countersignatory_value_sat, htlcs_with_aux, channel_parameters, opt_anchors, &broadcaster_funding_key, &countersignatory_funding_key).unwrap();
@@ -1298,7 +1298,7 @@ impl CommitmentTransaction {
 
 	/// Use non-zero fee anchors
 	
-	// (C-not exported) due to move, and also not likely to be useful for binding users
+	/// (This is not exported to bindings users) due to move, and also not likely to be useful for binding users
 	pub fn with_non_zero_fee_anchors(mut self) -> Self {
 		self.opt_non_zero_fee_anchors = Some(());
 		self
@@ -1479,8 +1479,8 @@ impl CommitmentTransaction {
 	/// which were included in this commitment transaction in output order.
 	/// The transaction index is always populated.
 	
-	// (C-not exported) as we cannot currently convert Vec references to/from C, though we should
-	// expose a less effecient version which creates a Vec of references in the future.
+	/// (This is not exported to bindings users) as we cannot currently convert Vec references to/from C, though we should
+	/// expose a less effecient version which creates a Vec of references in the future.
 	pub fn htlcs(&self) -> &Vec<HTLCOutputInCommitment> {
 		&self.htlcs
 	}

lightning/src/ln/channelmanager.rs

@@ -198,8 +198,20 @@ struct ClaimableHTLC {
 }
 
 /// A payment identifier used to uniquely identify a payment to LDK.
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
 
-// (C-not exported) as we just use [u8; 32] directly
+/// (This is not exported to bindings users) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct PaymentId(pub [u8; 32]);
 
@@ -217,8 +229,26 @@ impl Readable for PaymentId {
 }
 
 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
+///
 
-// (C-not exported) as we just use [u8; 32] directly
+/// (This is not exported to bindings users) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct InterceptId(pub [u8; 32]);
 
@@ -568,8 +598,9 @@ struct PendingInboundPayment {
 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
+///
 
-// (C-not exported) as Arcs don't make sense in bindings
+/// (This is not exported to bindings users) as Arcs don't make sense in bindings
 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
 	Arc<M>,
 	Arc<T>,
@@ -593,8 +624,9 @@ pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
+///
 
-// (C-not exported) as Arcs don't make sense in bindings
+/// (This is not exported to bindings users) as Arcs don't make sense in bindings
 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'c KeysManager, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
 
 /// Manager which keeps track of a number of channels and sends messages to the appropriate
@@ -7211,7 +7243,7 @@ where
 	/// In such cases the latest local transactions will be sent to the tx_broadcaster included in
 	/// this struct.
 	
-	// (C-not exported) because we have no HashMap bindings
+	/// (This is not exported to bindings users) because we have no HashMap bindings
 	pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
 }
 

lightning/src/ln/features.rs

@@ -392,8 +392,9 @@ mod sealed {
 
 /// Tracks the set of features which a node implements, templated by the context in which it
 /// appears.
+///
 
-// (C-not exported) as we map the concrete feature types below directly instead
+/// (This is not exported to bindings users) as we map the concrete feature types below directly instead
 #[derive(Eq)]
 pub struct Features<T: sealed::Context> {
 	/// Note that, for convenience, flags is LITTLE endian (despite being big-endian on the wire)
@@ -623,7 +624,7 @@ impl<T: sealed::Context> Features<T> {
 	/// Create a Features given a set of flags, in little-endian. This is in reverse byte order from
 	/// most on-the-wire encodings.
 	
-	// (C-not exported) as we don't support export across multiple T
+	/// (This is not exported to bindings users) as we don't support export across multiple T
 	pub fn from_le_bytes(flags: Vec<u8>) -> Features<T> {
 		Features {
 			flags,

lightning/src/ln/mod.rs

@@ -82,18 +82,21 @@ mod shutdown_tests;
 pub use self::peer_channel_encryptor::LN_MAX_MSG_LEN;
 
 /// payment_hash type, use to cross-lock hop
+///
 
-// (C-not exported) as we just use [u8; 32] directly
+/// (This is not exported to bindings users) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct PaymentHash(pub [u8; 32]);
 /// payment_preimage type, use to route payment between hop
+///
 
-// (C-not exported) as we just use [u8; 32] directly
+/// (This is not exported to bindings users) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct PaymentPreimage(pub [u8; 32]);
 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
+///
 
-// (C-not exported) as we just use [u8; 32] directly
+/// (This is not exported to bindings users) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct PaymentSecret(pub [u8; 32]);
 

lightning/src/ln/msgs.rs

@@ -938,8 +938,9 @@ pub struct CommitmentUpdate {
 /// As we wish to serialize these differently from `Option<T>`s (`Options` get a tag byte, but
 /// [`OptionalField`] simply gets `Present` if there are enough bytes to read into it), we have a
 /// separate enum type for them.
+///
 
-// (C-not exported) due to a free generic in `T`
+/// (This is not exported to bindings users) due to a free generic in `T`
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum OptionalField<T> {
 	/// Optional field is included in message