Struct DocComments

pub struct DocComments {
    pub types: FastIndexMap<Handle<Type>, Vec<String>>,
    pub struct_members: FastIndexMap<(Handle<Type>, usize), Vec<String>>,
    pub entry_points: FastIndexMap<usize, Vec<String>>,
    pub functions: FastIndexMap<Handle<Function>, Vec<String>>,
    pub constants: FastIndexMap<Handle<Constant>, Vec<String>>,
    pub global_variables: FastIndexMap<Handle<GlobalVariable>, Vec<String>>,
    pub module: Vec<String>,
}

Doc comments preceding items.

These can be used to generate automated documentation, IDE hover information or translate shaders with their context comments.

Fields

types: FastIndexMap<Handle<Type>, Vec<String>>

struct_members: FastIndexMap<(Handle<Type>, usize), Vec<String>>

entry_points: FastIndexMap<usize, Vec<String>>

functions: FastIndexMap<Handle<Function>, Vec<String>>

constants: FastIndexMap<Handle<Constant>, Vec<String>>

global_variables: FastIndexMap<Handle<GlobalVariable>, Vec<String>>

module: Vec<String>

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for DocComments

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for DocComments

fn clone(&self) -> DocComments

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocComments

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocComments

fn default() -> DocComments

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocComments

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocComments

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.