Scribd Logo
Upload

Welcome to Scribd!

  • Pre-Processing: Substitution Rules

    Uploaded by

    Sebastiano Panichella
    123 views3 pages
    Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation deviates from the API itself. The misleading documents inevitably confuse the API users, and thus hamper the quality of software built from such APIs considerably. In this paper, we propose an automated approach to detect the defects of documents by leveraging techniques from program comprehension and natural language processing. Particularly, we focus on the directives of the API documents which are related to parameter constraints and exception throwing declarations. A first-order logic based constraint solver is employed to detect such defects based on the obtained analysis results. We evaluate our approach on parts of well documented JDK 1.8 APIs. Experiment results show that, out of more than 2000 API usage constraints, our approach can detect 1297 defective document directives, with a precision rate of 72.5%, and a recall rate of 80.2%, which demonstrates its practical feasibility.

    Original Title

    Patterns

    Copyright

    © © All Rights Reserved

    Available Formats

    PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Report this Document
    Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation deviates from the API itself. The misleading documents inevitably confuse the API users, and thus hamper the quality of software built from such APIs considerably. In this paper, we propose an automated approach to detect the defects of documents by leveraging techniques from program comprehension and natural language processing. Particularly, we focus on the directives of the API documents which are related to parameter constraints and exception throwing declarations. A first-order logic based constraint solver is employed to detect such defects based on the obtained analysis results. We evaluate our approach on parts of well documented JDK 1.8 APIs. Experiment results show that, out of more than 2000 API usage constraints, our approach can detect 1297 defective document directives, with a precision rate of 72.5%, and a recall rate of 80.2%, which demonstrates its practical feasibility.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    123 views3 pages

    Pre-Processing: Substitution Rules

    Uploaded by

    Sebastiano Panichella
    Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation deviates from the API itself. The misleading documents inevitably confuse the API users, and thus hamper the quality of software built from such APIs considerably. In this paper, we propose an automated approach to detect the defects of documents by leveraging techniques from program comprehension and natural language processing. Particularly, we focus on the directives of the API documents which are related to parameter constraints and exception throwing declarations. A first-order logic based constraint solver is employed to detect such defects based on the obtained analysis results. We evaluate our approach on parts of well documented JDK 1.8 APIs. Experiment results show that, out of more than 2000 API usage constraints, our approach can detect 1297 defective document directives, with a precision rate of 72.5%, and a recall rate of 80.2%, which demonstrates its practical feasibility.

    Copyright:

    © All Rights Reserved
    Download as PDF, TXT or read online from Scribd
    Flag for inappropriate content
    of 3

    Pre-processing

    Substitution rules (17)


    Type

    Description

    Regular expression

    Specific

    0.0, 0.1f, etc.

    \W(-)?[0-9]+(,[0-9]+)*((\.[0-9]+)?[a-z]*)\W

    values (2)

    Member value of objects,

    \W(^(java\.|javax\.|org\.))?([A-Za-z_]+\w+\.)+[a

    e.g., Location.x

    -z_]+[a-z0-9_]*[^\.A-Za-z0-9_]

    Class

    class

    methods,

    e.g.,

    methods

    ClassA.func(Param1)

    and static

    \W[A-Za-z_]+[A-Za-z_0-9]*(\.[A-Za-z_]+[A-Zaz_0-9])*(#[A-Za-z_]+[A-Za-z_0-9]*)?\([^()]*\)\
    W

    members

    Static

    (4)

    Desktop.Action#OPEN

    member,

    e.g.,

    \W([A-Za-z_]+[A-Za-z_0-9]*(\.[A-Za-z_]+[A-Za
    -z_0-9])*)?(#[A-Za-z_]+[A-Za-z_0-9]*)[^A-Za-z
    0-9_()]

    All upper case

    \W(\w+\.)*([A-Z]+_)*[A-Z]+\W

    Class name

    \W([A-Za-z_]+\w+\.)*[A-Za-z_]*[A-Z]+\w+[^\.AZa-z0-9_]

    Expressio

    A-B

    \W\w+((\s+-)|(-\s+)|(\s+-\s+))\w+\W

    ns (11)

    A+B

    \W\w+\s*\+\s*\w+\W

    A*B

    \W\w+\s*\*\s*\w+\W

    A..B

    \W\(?\s*\w+\s*\)?\s*\.\s*\.\s*\(?\s*\w+\s*\)?\W

    [A, B]

    \W\[\s*\w+\s*,\s*\w+\s*\]\W

    [A..B]

    \W\[\s*\w+\s*(\.\s*\.\s*)\s*\w+\s*\]\W

    A <\<= B <\<= C

    \W\w+\s*<=?\s*\w+\s*<=?\s*\w+\W

    A >\>= B >\>= C

    \W\w+\s*>=?\s*\w+\s*>=?\s*\w+\W

    From A to B

    \W(from\s+)?\w+\s+to\s+\w+\W

    A != B

    \W\w+\s*!=\s*\w+\W

    Enumeration expression

    \W (\s*\w+\s*)(,\s*\w+\s*)+,?\s*or\s*\w+\W

    Division rules of composite statements (12)

    Type

    Rule

    FRAG statements (2)

    FRAG -> SBAR


    FRAG > IN + NP

    SBAR statements (2)

    SBAR > IN(if) + S


    SBAR > SBAR + CC + SBAR

    S statements (2)

    S -> S + CC + S
    S -> NP + VP

    VP statements (3)

    VP-> VP+CC + VP
    VP-> VBZ+ADJP/UCP
    VP-> VBZ + ADJP +

    NP statements (1)

    NP -> NP + CC + NP

    ADJP statements (1)

    ADJP -> ? + CC + ?

    UCP statements (1)

    UCP > ? + CC + ?

    You might also like