clean doc

This commit is contained in:
Jean-Marie Mineau 2023-08-30 14:18:32 +02:00
parent b5ae8c5088
commit df2a441148
Signed by: histausse
GPG key ID: B66AEEDA9B645AD2
13 changed files with 84 additions and 80 deletions

View file

@ -15,7 +15,7 @@ pub use header::*;
pub use hiddenapi::*;
pub use map::*;
/// https://source.android.com/docs/core/runtime/dex-format#string-item
/// <https://source.android.com/docs/core/runtime/dex-format#string-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct StringIdItem {
@ -24,7 +24,7 @@ pub struct StringIdItem {
pub use crate::StringDataItem;
/// https://source.android.com/docs/core/runtime/dex-format#type-id-item
/// <https://source.android.com/docs/core/runtime/dex-format#type-id-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct TypeIdItem {
@ -32,7 +32,7 @@ pub struct TypeIdItem {
pub descriptor_idx: u32,
}
/// https://source.android.com/docs/core/runtime/dex-format#proto-id-item
/// <https://source.android.com/docs/core/runtime/dex-format#proto-id-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct ProtoIdItem {
@ -44,7 +44,7 @@ pub struct ProtoIdItem {
pub parameters_off: u32,
}
/// https://source.android.com/docs/core/runtime/dex-format#field-id-item
/// <https://source.android.com/docs/core/runtime/dex-format#field-id-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct FieldIdItem {
@ -56,7 +56,7 @@ pub struct FieldIdItem {
pub name_idx: u32,
}
/// https://source.android.com/docs/core/runtime/dex-format#method-id-item
/// <https://source.android.com/docs/core/runtime/dex-format#method-id-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct MethodIdItem {
@ -68,7 +68,7 @@ pub struct MethodIdItem {
pub name_idx: u32,
}
/// https://source.android.com/docs/core/runtime/dex-format#call-site-id-item
/// <https://source.android.com/docs/core/runtime/dex-format#call-site-id-item>
/// alignment: 4 bytes
#[derive(Serializable, Debug, Clone, Copy, PartialEq, Eq)]
pub struct CallSiteIdItem {
@ -76,23 +76,23 @@ pub struct CallSiteIdItem {
pub call_site_off: u32,
}
/// https://source.android.com/docs/core/runtime/dex-format#encoded-array-item
/// <https://source.android.com/docs/core/runtime/dex-format#encoded-array-item>
/// alignment: none
#[derive(Serializable, Debug, Clone, PartialEq, Eq)]
pub struct EncodedArrayItem {
pub value: EncodedArray,
}
/// https://source.android.com/docs/core/runtime/dex-format#call-site-item
/// <https://source.android.com/docs/core/runtime/dex-format#call-site-item>
///
/// The call_site_item is an encoded_array_item whose elements correspond to
/// the arguments provided to a bootstrap linker method.
///
/// The first three arguments are:
/// - A method handle representing the bootstrap linker method ([`EncodedValue::MethodHandle`])
/// - A method name that the bootstrap linker should resolve ([`EncodedValue::String`])
/// - A method handle representing the bootstrap linker method ([`crate::EncodedValue::MethodHandle`])
/// - A method name that the bootstrap linker should resolve ([`crate::EncodedValue::String`])
/// - A method type corresponding to the type of the method name to be resolved
/// ([`EncodedValue::MethodType`])
/// ([`crate::EncodedValue::MethodType`])
///
/// Any additional arguments are constant values passed to the bootstrap linker method.
/// These arguments are passed in order and without any type conversions.