mxmlextrema_as3parser/tree/
asdoc.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
use crate::ns::*;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Asdoc {
    pub location: Location,
    pub main_body: Option<(String, Location)>,
    pub tags: Vec<(AsdocTag, Location)>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum AsdocTag {
    Author(String),
    Copy(Rc<AsdocReference>),
    Created(String),
    Default(String),
    Deprecated {
        message: Option<String>,
    },
    EventType(Rc<Expression>),
    Example(String),
    InheritDoc,
    Internal(String),
    Langversion(String),
    Param {
        name: String,
        description: String,
    },
    Playerversion(String),
    Private,
    Productversion(String),
    Return(String),
    See {
        reference: Rc<AsdocReference>,
        display_text: Option<String>,
    },
    Throws {
        class_reference: Rc<Expression>,
        description: Option<String>,
    },
    Version(String),
}

/// An ASDoc reference consisting of an optional base and
/// an optional instance property fragment (`#x`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AsdocReference {
    /// Base expression.
    pub base: Option<Rc<Expression>>,
    /// Instance property fragment following the hash character.
    pub instance_property: Option<Rc<QualifiedIdentifier>>,
}