Openbravo Issue Tracking System - Openbravo ERP
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0031481Openbravo ERPA. Platformpublic2015-11-14 14:162015-11-26 09:43
Reportershuehner 
Assigned Toshuehner 
PrioritynormalSeverityminorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionFixed in Version3.0PR16Q1 
Merge Request Status
Review Assigned Toalostale
OBNetwork customerNo
Web browser
ModulesCore
Support ticket
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary0031481: Fix javadoc generation
DescriptionGenerating javadoc for pi using the 'ant generate.java.doc' target has quite some problems. One introduced by not updating the target in the latest src-test/cdi changes + but also lots of old issues there since a long time.

This issue is to fix the following items:
- remove linksource=no as that is default already
- fix ${base.src.test} reference as that should be §{base.src.test}/src as otherwise it reads packages as src.org.openbravo.test instead of org.openbravo.test
- add src + src-test below any installed modules when generating docs, as otherwise half of code is not covered
- add jar files below modules/*/lib/test to find references to those in test code
- update link to java6 core docs from outdated java.sun.com url to docs.oracle.com (note: keep at java6 as that is still oldest version supported)

Plus through in 3 unrelated javadoc syntax fixes to fix up javadoc warnings shown on generation
Steps To Reproducerun ant generate.java.doc and notice the many errors and warnings happening
Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2015-11-14 14:16shuehnerNew Issue
2015-11-14 14:16shuehnerAssigned To => shuehner
2015-11-14 14:16shuehnerOBNetwork customer => No
2015-11-14 14:16shuehnerModules => Core
2015-11-14 14:16shuehnerTriggers an Emergency Pack => No
2015-11-16 14:01shuehnerReview Assigned To => alostale
2015-11-16 19:18hgbotCheckin
2015-11-16 19:18hgbotNote Added: 0081909
2015-11-16 19:18hgbotStatusnew => resolved
2015-11-16 19:18hgbotResolutionopen => fixed
2015-11-16 19:18hgbotFixed in SCM revision => http://code.openbravo.com/erp/devel/pi/rev/b252497be371e0adf8bb4288ce214c23c0126996 [^]
2015-11-26 09:43alostaleNote Added: 0082359
2015-11-26 09:43alostaleStatusresolved => closed
2015-11-26 09:43alostaleFixed in Version => 3.0PR16Q1

Notes
(0081909)
hgbot   
2015-11-16 19:18   
Repository: erp/devel/pi
Changeset: b252497be371e0adf8bb4288ce214c23c0126996
Author: Stefan Hühner <stefan.huehner <at> openbravo.com>
Date: Sat Nov 14 14:19:01 2015 +0100
URL: http://code.openbravo.com/erp/devel/pi/rev/b252497be371e0adf8bb4288ce214c23c0126996 [^]

Fixed 31481: Fix & improve javadoc generation

- add modules src + src-test to generated javadoc to not miss all the
  code in modules in the docs (convert to subelement sourcepath for this)
- fix referencing java sources in src-test by adding /src to the reference
- add modules/*/lib/test/*.jar to find referenced class in test code
- update link to standard java6 javadoc to use newer url

- 2-3 simple javadoc syntax fixes in java files

---
M build.xml
M modules/org.openbravo.client.application/src/org/openbravo/client/application/report/ReportingUtils.java
M modules/org.openbravo.service.json/src/org/openbravo/service/json/UnpagedRequestCachedPreference.java
M src/org/openbravo/financial/FinancialUtils.java
---
(0082359)
alostale   
2015-11-26 09:43   
code reviewed

generated javadoc looks fine