Openbravo Issue Tracking System - Openbravo ERP
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0041629Openbravo ERPA. Platformpublic2019-08-12 10:372019-12-12 23:01
ReporterAugustoMauch 
Assigned Tocberner 
PrioritynormalSeverityminorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionFixed in Version3.0PR20Q1 
Merge Request Status
Review Assigned ToAugustoMauch
OBNetwork customerNo
Web browser
ModulesCore
Support ticket
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary0041629: improve javadoc of generated entities: Include help for table and columns
DescriptionJavaDoc generated for DAL entities classes can be improved:

* Include help for table and columns. Note this would increase in-memory model, this information should only be used to generate code but not retained in final model. Also a proper escape would be needed to prevent invalid code.
Steps To Reproduce-
Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
related to defect 0041988 closed cberner API Change: Removed developmentStatus on Column class used for code generation 
causes defect 0042067 closed cberner Eclipse warnings caused by javadoc changes 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2019-08-12 10:37AugustoMauchNew Issue
2019-08-12 10:37AugustoMauchAssigned To => platform
2019-08-12 10:37AugustoMauchOBNetwork customer => No
2019-08-12 10:37AugustoMauchModules => Core
2019-08-12 10:37AugustoMauchTriggers an Emergency Pack => No
2019-08-12 10:37AugustoMauchIssue generated from0040837
2019-08-12 10:40AugustoMauchSummaryimprove javadoc of generated entities => improve javadoc of generated entities: Include help for table and columns
2019-08-12 10:40AugustoMauchDescription Updatedbug_revision_view_page.php?rev_id=19297#r19297
2019-08-12 10:40AugustoMauchAssigned Toplatform => cberner
2019-08-12 14:20cbernerStatusnew => scheduled
2019-08-19 14:33cbernerReview Assigned To => AugustoMauch
2019-10-16 11:13hgbotCheckin
2019-10-16 11:13hgbotNote Added: 0115105
2019-10-16 11:13hgbotStatusscheduled => resolved
2019-10-16 11:13hgbotResolutionopen => fixed
2019-10-16 11:13hgbotFixed in SCM revision => http://code.openbravo.com/erp/devel/pi/rev/640df6f887be0f091a25bba4177800837297c8fa [^]
2019-10-16 11:14AugustoMauchRelationship addedrelated to 0041988
2019-10-16 16:14AugustoMauchNote Added: 0115124
2019-10-16 16:14AugustoMauchStatusresolved => closed
2019-10-16 16:14AugustoMauchFixed in Version => 3.0PR20Q1
2019-10-18 12:56alostaleRelationship addedcauses 0042067
2019-12-12 23:01hudsonbotCheckin
2019-12-12 23:01hudsonbotNote Added: 0116249

Notes
(0115105)
hgbot   
2019-10-16 11:13   
Repository: erp/devel/pi
Changeset: 640df6f887be0f091a25bba4177800837297c8fa
Author: Cristian Berner <cristian.berner <at> openbravo.com>
Date: Wed Oct 09 13:42:09 2019 +0200
URL: http://code.openbravo.com/erp/devel/pi/rev/640df6f887be0f091a25bba4177800837297c8fa [^]

fixes issue 41629: Include help for table and columns in generated javadoc

Help messages have been added to entities and properties in Javadoc.
For table, help message is shown at the start of the corresponding class.
For column, help message is shown over corresponding property.
If no help message has been added to correpsonding column/table, it is not shown.

---
M src-test/src/org/openbravo/test/model/RuntimeModelTest.java
M src/org/openbravo/base/gen/GenerateEntitiesTask.java
M src/org/openbravo/base/gen/entity.ftl
M src/org/openbravo/base/model/Column.hbm.xml
M src/org/openbravo/base/model/Column.java
M src/org/openbravo/base/model/Entity.java
M src/org/openbravo/base/model/ModelProvider.java
M src/org/openbravo/base/model/Property.java
M src/org/openbravo/base/structure/ClientEnabled.java
M src/org/openbravo/base/structure/OrganizationEnabled.java
---
(0115124)
AugustoMauch   
2019-10-16 16:14   
Code reviewed and verified
(0116249)
hudsonbot   
2019-12-12 23:01   
A changeset related to this issue has been promoted main and to the
Central Repository, after passing a series of tests.

Promotion changeset: https://code.openbravo.com/erp/devel/main/rev/954d2b7a66fb [^]
Maturity status: Test