Mod4j: Modeling for Java using Domain Specific Languages

Add document to the argument and return type in the 'method' declaration

Details

  • Type: New Feature New Feature
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.1.0
  • Component/s: DSL for Services
  • Labels:
    None
  • Number of attachments :
    0

Description

In the Service DSL, I'd like to properly document custom methods but I am unable to write documentation for the return type and arguments.

something.sermod
"This method enables you to search based on a searchQuery."
method something in [ "Contains the query to execute." StringDto searchQuery;
                                        "Controls whether or not the returned List is ordered." BooleanDto ordered;
                                       ]
                                  out  "The list of found objects." CoolListDto;

The obvious workaround is to write @param stuff in the method documentation.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Vincent Lussenburg added a comment -

Forgot to mention that the first piece of comment does not result in errors in Mod4j, but the subsequent three comment block are not allowed.

Show
Vincent Lussenburg added a comment - Forgot to mention that the first piece of comment does not result in errors in Mod4j, but the subsequent three comment block are not allowed.
Hide
Permalink
Vincent Lussenburg added a comment -

This also applies to Enumeration, you can't set documentation on the individual enum values.

enumeration Something [
  "docs"
  ONE = 1;
]

this cannot be parsed.

Show
Vincent Lussenburg added a comment - This also applies to Enumeration, you can't set documentation on the individual enum values. 
enumeration Something [
  "docs"
  ONE = 1;
]
this cannot be parsed.
Hide
Permalink
Jos Warmer added a comment -

Added description to the parameters. Thi ends up in gnerated @param javdoc tags
Will not be added to the return type

Show
Jos Warmer added a comment - Added description to the parameters. Thi ends up in gnerated @param javdoc tags Will not be added to the return type

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.