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 Clone for DocComments

fn clone(&self) -> DocComments

Returns a duplicate 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.