From 9e7937b95683c99400c730c0881380adb4d1c6a0 Mon Sep 17 00:00:00 2001
From: Lokathor <zefria@gmail.com>
Date: Wed, 13 Feb 2019 01:46:47 -0700
Subject: [PATCH] tag TODOs in docs

---
 src/io/color_blend.rs |  8 ++++++++
 src/io/sound.rs       | 18 +++++++++++++++++-
 src/io/window.rs      |  4 ++++
 3 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/src/io/color_blend.rs b/src/io/color_blend.rs
index 837c505..6eea535 100644
--- a/src/io/color_blend.rs
+++ b/src/io/color_blend.rs
@@ -6,6 +6,7 @@ use super::*;
 pub const BLDCNT: VolAddress<ColorEffectSetting> = unsafe { VolAddress::new(0x400_0050) };
 
 newtype! {
+  /// TODO: docs
   ColorEffectSetting, u16
 }
 
@@ -29,10 +30,15 @@ impl ColorEffectSetting {
 }
 
 newtype_enum! {
+  /// TODO: docs
   ColorSpecialEffect = u16,
+  /// TODO: docs
   None = 0,
+  /// TODO: docs
   AlphaBlending = 1,
+  /// TODO: docs
   BrightnessIncrease = 2,
+  /// TODO: docs
   BrightnessDecrease = 3,
 }
 
@@ -40,6 +46,7 @@ newtype_enum! {
 pub const BLDALPHA: VolAddress<AlphaBlendingSetting> = unsafe { VolAddress::new(0x400_0052) };
 
 newtype! {
+  /// TODO: docs
   AlphaBlendingSetting, u16
 }
 
@@ -55,6 +62,7 @@ impl AlphaBlendingSetting {
 pub const BLDY: VolAddress<BrightnessSetting> = unsafe { VolAddress::new(0x400_0054) };
 
 newtype! {
+  /// TODO: docs
   BrightnessSetting, u32
 }
 
diff --git a/src/io/sound.rs b/src/io/sound.rs
index 7d3e98e..dcb6736 100644
--- a/src/io/sound.rs
+++ b/src/io/sound.rs
@@ -1,4 +1,5 @@
-///! Module for sound registers.
+//! Module for sound registers.
+
 use super::*;
 
 //TODO within these "read/write" registers only some bits are actually read/write!
@@ -7,6 +8,7 @@ use super::*;
 pub const SOUND1CNT_L: VolAddress<SweepRegisterSetting> = unsafe { VolAddress::new(0x400_0060) };
 
 newtype! {
+  /// TODO: docs
   SweepRegisterSetting, u16
 }
 
@@ -23,6 +25,7 @@ impl SweepRegisterSetting {
 pub const SOUND1CNT_H: VolAddress<DutyLenEnvelopeSetting> = unsafe { VolAddress::new(0x400_0062) };
 
 newtype! {
+  /// TODO: docs
   DutyLenEnvelopeSetting, u16
 }
 
@@ -41,6 +44,7 @@ impl DutyLenEnvelopeSetting {
 pub const SOUND1CNT_X: VolAddress<FrequencyControlSetting> = unsafe { VolAddress::new(0x400_0064) };
 
 newtype! {
+  /// TODO: docs
   FrequencyControlSetting, u32 // TODO: u16 or u32?
 }
 
@@ -64,6 +68,7 @@ pub const SOUND3CNT_L: VolAddress<StopWaveRAMSelectSetting> =
   unsafe { VolAddress::new(0x400_0070) };
 
 newtype! {
+  /// TODO: docs
   StopWaveRAMSelectSetting, u16
 }
 
@@ -80,6 +85,7 @@ impl StopWaveRAMSelectSetting {
 pub const SOUND3CNT_H: VolAddress<LengthVolumeSetting> = unsafe { VolAddress::new(0x400_0072) };
 
 newtype! {
+  /// TODO: docs
   LengthVolumeSetting, u16
 }
 
@@ -116,6 +122,7 @@ pub const WAVE_RAM3_H: VolAddress<u16> = unsafe { VolAddress::new(0x400_009E) };
 pub const SOUND4CNT_L: VolAddress<LengthEnvelopeSetting> = unsafe { VolAddress::new(0x400_0078) };
 
 newtype! {
+  /// TODO: docs
   LengthEnvelopeSetting, u32 // TODO: is this u32?
 }
 
@@ -133,6 +140,7 @@ impl LengthEnvelopeSetting {
 pub const SOUND4CNT_H: VolAddress<NoiseFrequencySetting> = unsafe { VolAddress::new(0x400_007C) };
 
 newtype! {
+  /// TODO: docs
   NoiseFrequencySetting, u32 // TODO: is this u32?
 }
 
@@ -163,6 +171,7 @@ pub const SOUNDCNT_L: VolAddress<NonWaveVolumeEnableSetting> =
   unsafe { VolAddress::new(0x400_0080) };
 
 newtype! {
+  /// TODO: docs
   NonWaveVolumeEnableSetting, u16
 }
 
@@ -180,6 +189,7 @@ impl NonWaveVolumeEnableSetting {
 pub const SOUNDCNT_H: VolAddress<WaveVolumeEnableSetting> = unsafe { VolAddress::new(0x400_0082) };
 
 newtype! {
+  /// TODO: docs
   WaveVolumeEnableSetting, u16
 }
 
@@ -201,9 +211,13 @@ impl WaveVolumeEnableSetting {
 }
 
 newtype_enum! {
+  /// TODO: docs
   NumberSoundVolume = u16,
+  /// TODO: docs
   Quarter = 0,
+  /// TODO: docs
   Half = 1,
+  /// TODO: docs
   Full = 2,
 }
 
@@ -211,6 +225,7 @@ newtype_enum! {
 pub const SOUNDCNT_X: VolAddress<SoundMasterSetting> = unsafe { VolAddress::new(0x400_0084) };
 
 newtype! {
+  /// TODO: docs
   SoundMasterSetting, u16
 }
 
@@ -229,6 +244,7 @@ impl SoundMasterSetting {
 pub const SOUNDBIAS: VolAddress<SoundPWMSetting> = unsafe { VolAddress::new(0x400_0088) };
 
 newtype! {
+  /// TODO: docs
   SoundPWMSetting, u16
 }
 
diff --git a/src/io/window.rs b/src/io/window.rs
index 9c511af..c163824 100644
--- a/src/io/window.rs
+++ b/src/io/window.rs
@@ -9,6 +9,7 @@ pub const WIN0H: VolAddress<HorizontalWindowSetting> = unsafe { VolAddress::new(
 pub const WIN1H: VolAddress<HorizontalWindowSetting> = unsafe { VolAddress::new(0x400_0042) };
 
 newtype! {
+  /// TODO: docs
   HorizontalWindowSetting, u16
 }
 
@@ -27,6 +28,7 @@ pub const WIN0V: VolAddress<VerticalWindowSetting> = unsafe { VolAddress::new(0x
 pub const WIN1V: VolAddress<VerticalWindowSetting> = unsafe { VolAddress::new(0x400_0046) };
 
 newtype! {
+  /// TODO: docs
   VerticalWindowSetting, u16
 }
 
@@ -42,6 +44,7 @@ impl VerticalWindowSetting {
 pub const WININ: VolAddress<InsideWindowSetting> = unsafe { VolAddress::new(0x400_0048) };
 
 newtype! {
+  /// TODO: docs
   InsideWindowSetting, u16
 }
 
@@ -67,6 +70,7 @@ impl InsideWindowSetting {
 pub const WINOUT: VolAddress<OutsideWindowSetting> = unsafe { VolAddress::new(0x400_004A) };
 
 newtype! {
+  /// TODO: docs
   OutsideWindowSetting, u16
 }