Mod4j: Modeling for Java using Domain Specific Languages

No documentation is added for special service methods e.g. find and listall.

Details

  • Type: Bug Bug
  • 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

No documentation from the DSL is applied to the actual source code it seems.

ProjectX.sermod
"List all Bedrijfsonderdelen."
listall listAllBedrijfsonderdeelDtos for BedrijfsonderdeelDto ;

"Zoek een vacature gebaseerd op een voorbeeld object."
find findVacature for VacatureDto;
ProjectXServiceModelLocalService.java
/**
	 * 
	 */
	public List<BedrijfsonderdeelDto> listAllBedrijfsonderdeelDtos();

	/**
	 * Find method: 
	 */
	public List<VacatureDto> findVacature(VacatureDto example);

The implementation is also without javadoc. This behaviour occurs for the 'find' and 'listall' keywords but it might affect more.

Activity

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

Also applies to for ... reference ... add/remove/get.

Show
Vincent Lussenburg added a comment - Also applies to for ... reference ... add/remove/get.
Hide
Permalink
Vincent Lussenburg added a comment -

Also applies for custom methods in the sermod (method [ in [ ...; ...; ] out ... ; ]. Also, the custom method is generated with Javadoc errors:

something.sermod
/** 
	 * Description: 
	 * @params [specialismen, trefwoorden]
	 * @return VacatureListDto
	 */
	public List<VacatureDto> zoekVacatureOpTrefwoordEnSpecialismen(
			List<SpecialismeDto> specialismen, StringDto trefwoorden);

The @params value gives a Javadoc error. Also, for custom methods, I'd probably want to add manual documentation for every argument and the return type. This is not possible in the DSL and I'll add a feature request for that.

Show
Vincent Lussenburg added a comment - Also applies for custom methods in the sermod (method [ in [ ...; ...; ] out ... ; ]. Also, the custom method is generated with Javadoc errors:
something.sermod
/** 
	 * Description: 
	 * @params [specialismen, trefwoorden]
	 * @return VacatureListDto
	 */
	public List<VacatureDto> zoekVacatureOpTrefwoordEnSpecialismen(
			List<SpecialismeDto> specialismen, StringDto trefwoorden);
The @params value gives a Javadoc error. Also, for custom methods, I'd probably want to add manual documentation for every argument and the return type. This is not possible in the DSL and I'll add a feature request for that.
Hide
Permalink
Vincent Lussenburg added a comment -

Documentation set on properties in the Business DSL is also not applied to the Dto, and I can't specify documentation for them manually.

Since the Dto is (almost?) always based on the business domain object, I'd prefer "@see" or "{@link ... }" javadoc to be generated (DRY principle) and my custom comments to be appended to that javadoc.

Show
Vincent Lussenburg added a comment - Documentation set on properties in the Business DSL is also not applied to the Dto, and I can't specify documentation for them manually. Since the Dto is (almost?) always based on the business domain object, I'd prefer "@see" or "{@link ... }" javadoc to be generated (DRY principle) and my custom comments to be appended to that javadoc.
Hide
Permalink
Jos Warmer added a comment -

Solved, javaDoc compliant documentation is generated.

Show
Jos Warmer added a comment - Solved, javaDoc compliant documentation is generated.
Hide
Permalink
Jos Warmer added a comment -

Adedd to the correct release.

Show
Jos Warmer added a comment - Adedd to the correct release.

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.