coffeedoc/codo

@abstract message display inconsistent

wayne-weibel opened this issue · 0 comments

When using the abstract tag, the message is not being displayed in the method summary or at the function description:

    ###
    @abstract implementation should return the resulting {PartContainerModel}

    @param partTemplate [ItemModel] the item

    @return [null]
    ###
    getPriceGroup: (partTemplate) ->
      null

summary-abstract-w-msg
abstract-with-message


In contrast, if using only the tag with no message, and instead put the 'message' as the function description then a block is displayed above the function description declaring it as abstract, but no indication in the summary:

    ###
    @abstract
    implementation should return the resulting {PartContainerModel}

    @param partTemplate [ItemModel] the item

    @return [null]
    ###
    getPriceGroup: (partTemplate) ->
      null

abstract-summary-msg-as-descr
abstract-message-as-description


Would like to have the the abstract flag in the summary and the block displayed at the function description. The assumption is that the abstract message would indicate specifics of what to return, while a normal function description could still be present to add more context.

This and issue #235 may simply be related to using the default theme.

My current workaround is to do:

    ###
    @abstract ...
    implementation should return the resulting {PartContainerModel}

    @param partTemplate [ItemModel] the item

    @return [null]
    ###
    getPriceGroup: (partTemplate) ->
      null

summary-abstract-msg-workaround
abstract-message-workaround