Opened 12 years ago

Closed 12 years ago

#5248 closed defect (fixed)

The doctool appears to ignore a "returns:" keyword description if there is a return type specification

Reported by: simonjb Owned by: Neil Roberts
Priority: high Milestone: 1.1
Component: Doc parser Version: 1.0
Keywords: Cc: dante
Blocked By: Blocking:

Description

In util/docscripts/_browse.php the following code has a returns value of "Boolean". The text description of the "returns:" keyword is not present.

hasWaiRole: function(/*Element*/ elem){
    // summary: Determines if an element has a role.
    // returns: true if elem has a role attribute and false if not.
    if(elem.hasAttribute){
        return elem.hasAttribute("role"); // Boolean
    }else{
        return elem.getAttribute("role") ? true : false; // Boolean
    }
}

Is the behaviour that I am seeing a bug or is it expected? One solution would be for me to not use return type comments and only have a "returns:" keyword comment. However, the styleguide suggests that return type information not be placed in the "returns:" keyword. Maybe that should be updated?

Change History (3)

comment:1 Changed 12 years ago by dante

Milestone: 1.1
Priority: normalhigh

comment:2 Changed 12 years ago by Neil Roberts

Status: newassigned

Currently being worked on

comment:3 Changed 12 years ago by Neil Roberts

Resolution: fixed
Status: assignedclosed

Fixed in r12987. Return type/summary will be added to the theme on redesign shortly.

Note: See TracTickets for help on using tickets.