Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Require Docs in Private Items #488

Closed
wants to merge 2 commits into from
Closed

chore: Require Docs in Private Items #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a04a5f
added lint
LittleTealeaf Apr 23, 2024
619de74
some documentation
LittleTealeaf Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ resolver = "2"
authors = ["LittleTealeaf"]
description = "A Cross-Platform Dungeons & Dragons Online Build Planner written in Rust."
categories = ["ddo", "builder", "rust"]
keywords = ["ddo", "dungeons & dragons online", "builder", "planner"]
keywords = ["ddo", "dungeons and dragons online", "builder", "planner"]
repository = "https://www.github.com/LittleTealeaf/ddo-build-planner"
readme = "./README.md"
license-file = "LICENSE"
Expand All @@ -31,6 +31,7 @@ format_push_string = "warn"
get_unwrap = "warn"
if_then_some_else_none = "warn"
missing_assert_message = "warn"
missing_docs_in_private_items = "warn"
mod_module_files = "warn"
std_instead_of_core = "warn"
str_to_string = "warn"
Expand Down
31 changes: 31 additions & 0 deletions builder/src/breakdowns/base.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ pub fn get_base_bonuses() -> impl Iterator<Item = Bonus> {
.map(|bonus| bonus.to_bonus(BonusSource::Base))
}

/// Provides +8 bonus to all ability scores, and sets the ability modifier based on the ability score
fn ability_bonuses() -> impl IntoIterator<Item = BonusTemplate> {
Ability::ABILITIES
.into_iter()
Expand All @@ -63,6 +64,11 @@ fn ability_bonuses() -> impl IntoIterator<Item = BonusTemplate> {
)))
}

/// Provides ability score bonuses to [`Reflex`], [`Fortitude`], and [`Will`]
///
/// [`Reflex`]: SavingThrow::Reflex
/// [`Fortitude`]: SavingThrow::Fortitude
/// [`Will`]: SavingThrow::Will
fn saving_throw() -> impl IntoIterator<Item = BonusTemplate> {
[
(Ability::Dexterity, SavingThrow::Reflex),
Expand All @@ -80,6 +86,11 @@ fn saving_throw() -> impl IntoIterator<Item = BonusTemplate> {
})
}

/// Forwards the total from a [`PRIMARY`] Saving Throw to [`SECONDARY`] Saving Throws based on [`get_parent()`]
///
/// [`PRIMARY`]: SavingThrow::PRIMARY
/// [`SECONDARY`]: SavingThrow::SECONDARY
/// [`get_parent()`]: SavingThrow::get_parent
fn secondary_saves() -> impl Iterator<Item = BonusTemplate> {
SavingThrow::SECONDARY.into_iter().filter_map(|skill| {
Some(BonusTemplate::new(
Expand All @@ -91,6 +102,11 @@ fn secondary_saves() -> impl Iterator<Item = BonusTemplate> {
})
}

/// Applies skill bonuses to spell powers, such as from [`Heal`], [`Perform`], and [`Spellcraft`]
///
/// [`Heal`]: Skill::Heal
/// [`Perform`]: Skill::Perform
/// [`Spellcraft`]: Skill::Spellcraft
fn spell_power_skills() -> impl IntoIterator<Item = BonusTemplate> {
[
(Skill::Heal, DamageType::Positive),
Expand All @@ -115,6 +131,9 @@ fn spell_power_skills() -> impl IntoIterator<Item = BonusTemplate> {
})
}

/// Provides bonuses from ability modifiers to skills using [`get_ability()`]
///
/// [`get_ability()`]: Skill::get_ability
fn skill() -> impl IntoIterator<Item = BonusTemplate> {
Skill::SKILLS.into_iter().filter_map(|skill| {
Some(BonusTemplate::new(
Expand All @@ -126,6 +145,7 @@ fn skill() -> impl IntoIterator<Item = BonusTemplate> {
})
}

/// Bonuses associated with Armor Classes
fn armor_class() -> impl IntoIterator<Item = BonusTemplate> {
[
// Dexterity Bonus to Armor Class
Expand Down Expand Up @@ -168,6 +188,7 @@ fn armor_class() -> impl IntoIterator<Item = BonusTemplate> {
]
}

/// Bonuses related to health and health scaling
fn health() -> impl IntoIterator<Item = BonusTemplate> {
[
BonusTemplate::new(
Expand All @@ -185,6 +206,7 @@ fn health() -> impl IntoIterator<Item = BonusTemplate> {
]
}

/// Bonuses related to spell points and spell point scaling
fn spell_points() -> impl IntoIterator<Item = BonusTemplate> {
[
BonusTemplate::new(
Expand All @@ -206,6 +228,11 @@ fn spell_points() -> impl IntoIterator<Item = BonusTemplate> {
]
}

/// Provides universal spell power bonuses to all other [`SpellPower`], [`SpellCriticalChance`], and [`SpellCriticalDamage`]
///
/// [`SpellPower`]: Attribute::SpellPower
/// [`SpellCriticalChance`]: Attribute::SpellCriticalChance
/// [`SpellCriticalDamage`]: Attribute::SpellCriticalDamage
fn spell_power_universal() -> impl IntoIterator<Item = BonusTemplate> {
[
Attribute::SpellPower,
Expand All @@ -225,6 +252,7 @@ fn spell_power_universal() -> impl IntoIterator<Item = BonusTemplate> {
})
}

/// Bonuses for calculations for Sheltering
fn sheltering() -> impl IntoIterator<Item = BonusTemplate> {
[
BonusTemplate::new(
Expand Down Expand Up @@ -254,6 +282,7 @@ fn sheltering() -> impl IntoIterator<Item = BonusTemplate> {
]
}

/// Calculations for the sheltering reduction value
fn sheltering_reduction() -> impl IntoIterator<Item = BonusTemplate> {
[
(Sheltering::PhysicalTotal, Sheltering::PhysicalReduction),
Expand All @@ -271,6 +300,7 @@ fn sheltering_reduction() -> impl IntoIterator<Item = BonusTemplate> {
})
}

/// Bonuses related to penalties from Armor Check Penalties
fn armor_check_penalties() -> impl Iterator<Item = BonusTemplate> {
[
(Skill::Balance, 1),
Expand All @@ -291,6 +321,7 @@ fn armor_check_penalties() -> impl Iterator<Item = BonusTemplate> {
})
}

/// Bonuses for Absorption stats
fn absorption() -> impl Iterator<Item = BonusTemplate> {
DamageType::get_static().map(|damage_type| {
BonusTemplate::new(
Expand Down
Loading