0007397: Some code has syntax errror in javadoc comment leading to problems when generating the javadoc html files

Openbravo Issue Tracking System - Openbravo ERP

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0007397

Openbravo ERP

A. Platform

public

2009-02-05 16:30

2009-02-05 16:31

Reporter

shuehner

Assigned To

shuehner

Priority

low

Severity

trivial

Reproducibility

have not tried

Status

closed

Resolution

no change required

Platform

OS Version

Product Version

2.40

Target Version

Fixed in Version

Merge Request Status

Review Assigned To

OBNetwork customer

Web browser

Modules

Core

Support ticket

Regression level

Regression date

Regression introduced in release

Regression introduced by commit

Triggers an Emergency Pack

Summary

0007397: Some code has syntax errror in javadoc comment leading to problems when generating the javadoc html files

Description

Some javadoc comments have a ":" character directly after the parameter names. This is wrong and leads to the javadoc tools not recognizing the name of the parameter.

Needed changes and completely in comment so zero real-code/functional change.

Steps To Reproduce

Built the javadoc for src/ and see that the parameter are not marked as parameters when they have a trailing ":" or enable the javadoc check warning in eclipse and see the warning. Javadoc @param tag missing for parameter.

Proposed Solution

Remove the wrong ":" character as shown in the diff-snippet below.

- * @param list: String with the list.
+ * @param list String with the list.

Additional Information