From a3920a922ed016996c05b5c0dffc52362a4b4321 Mon Sep 17 00:00:00 2001
From: Jamie Hardt <jamiehardt@me.com>
Date: Sun, 22 Nov 2020 13:24:09 -0800
Subject: [PATCH] Doc cleanup

---
 src/lib.rs | 86 +++++++++++++++++++++++++++++-------------------------
 1 file changed, 46 insertions(+), 40 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 7672018..5788149 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,44 +1,50 @@
-//! # bwavfile
-//! 
-//! Rust Wave File Reader/Writer with Broadcast-WAV, MBWF and RF64 Support
-//! 
-//! (Note: This crate is still in an alpha or pre-alpha stage of development. Reading of
-//! files works however the interfaces may change significantly. Stay up-to-date on the
-//! status of this project at [Github][github].)
-//! 
-//! [github]: https://github.com/iluvcapra/bwavfile
-//! 
-//! 
-//! ## Resources
-//!
-//! ### Implementation of Broadcast Wave Files
-//!     - [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
-//!
-//! ### Implementation of 64-bit Wave Files
-//!     - [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
-//!         - Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
-//!     - [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
-//!         - No longer in force, however long-established. 
-//!
-//!
-//! ### Implementation of Wave format `fmt` chunk
-//!     - [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
-//!     - [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
-//!
-//!
-//! ### Other resources
-//!     - [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries" 
-//!     - [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
-//!         - [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf) 
-//!     IBM Corporation and Microsoft Corporation, (August 1991)
-//!
-//! 
-//! [ebu3285]:  https://tech.ebu.ch/docs/tech/tech3285.pdf
-//! [ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
-//! [ebu3306v2]:  https://tech.ebu.ch/docs/tech/tech3306.pdf
-//! [itu2088]:  https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
-//! [rfc3261]:  https://tools.ietf.org/html/rfc2361
+//
+/*! 
+# bwavfile
+ 
+Rust Wave File Reader/Writer with Broadcast-WAV, MBWF and RF64 Support
+ 
+(Note: This crate is still in an alpha or pre-alpha stage of development. Reading of
+files works however the interfaces may change significantly. Stay up-to-date on the
+status of this project at [Github][github].)
 
+## Resources
+
+### Implementation of Broadcast Wave Files
+- [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
+
+### Implementation of 64-bit Wave Files
+- [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
+ - Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
+- [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
+ - No longer in force, however long-established. 
+
+
+### Implementation of Wave format `fmt` chunk
+- [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
+- [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
+
+
+### Other resources
+- [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries" 
+- [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
+ - [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf) 
+    IBM Corporation and Microsoft Corporation, (August 1991)
+
+
+[ebu3285]: https://tech.ebu.ch/docs/tech/tech3285.pdf
+[ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
+[ebu3306v2]: https://tech.ebu.ch/docs/tech/tech3306.pdf
+[itu2088]: https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
+[rfc3261]: https://tools.ietf.org/html/rfc2361
+[github]: https://github.com/iluvcapra/bwavfile
+*/
+
+// #![feature(external_doc)]
+
+// #[doc(include="../README.md")]
+// #[cfg(doctest)]
+// pub struct ReadmeDoctests;
 
 extern crate encoding;
 extern crate byteorder;