squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

ty: add doc comments to Generics methods

Browse source 
This commit adds doc comments to the `param_at`, `region_param` and
`const_param` methods on the `Generics` struct.

Signed-off-by: David Wood <david@davidtw.co>
This commit is contained in:
David Wood 2020-06-22 13:24:59 +01:00
parent ce7c48fa15
commit 842fa0ce3e
No known key found for this signature in database
GPG key ID: 2592E76C87381FD9
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/librustc_middle/ty/mod.rs
View file

@ -890,6 +890,7 @@ impl<'tcx> Generics {
false
}
/// Returns the `GenericParamDef` with the given index.
pub fn param_at(&'tcx self, param_index: usize, tcx: TyCtxt<'tcx>) -> &'tcx GenericParamDef {
if let Some(index) = param_index.checked_sub(self.parent_count) {
&self.params[index]
@ -899,6 +900,7 @@ impl<'tcx> Generics {
}
}
/// Returns the `GenericParamDef` associated with this `EarlyBoundRegion`.
pub fn region_param(
&'tcx self,
param: &EarlyBoundRegion,
@ -920,7 +922,7 @@ impl<'tcx> Generics {
}
}
/// Returns the `ConstParameterDef` associated with this `ParamConst`.
/// Returns the `GenericParamDef` associated with this `ParamConst`.
pub fn const_param(&'tcx self, param: &ParamConst, tcx: TyCtxt<'tcx>) -> &GenericParamDef {
let param = self.param_at(param.index as usize, tcx);
match param.kind {