0003487: add header to WAD generated files to help reading the code

Openbravo Issue Tracking System - Openbravo ERP

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0003487

Openbravo ERP

A. Platform

public

2008-04-15 16:48

2008-06-27 15:47

Reporter

user71

Assigned To

user71

Priority

normal

Severity

minor

Reproducibility

always

Status

closed

Resolution

duplicate

Platform

OS Version

Product Version

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

0003487: add header to WAD generated files to help reading the code

Description

Hi,

Here is something very simple you could do to help third party developpers understand and participate to Openbravo code.

Indeed, since you favored code generation over interpreted code (why?), there are currently lots of files, configuration and processes to generate the correct files. This makes it hard for the newbie to get the whole process and get involved into OB developpment.

So may be you can simply add some explicit header to WAD generated files, like "this file has been generated by ANT task xx after source file yy, do not edit it directly but edit yy instead".
Lot's of oss code generation projects do that actually.

Why would that help? Suppose I know standard J2EE developpement but not the particular OB plateform (usual case) and I see something going wrong with an OB server: from my general knowledge I manage to enter the involved servlet but then I get stuck because I see code generated Java files and HTML files. Instead I could simply read the header and know where I can tune OB code exactly to meet my own needs.

I know that it's currently explicitly stated which directories involve generated code. But I just think it's less obvious and you have to read the whole dev documentation to know that.

What do you think?

RaphaÃ«l Valyi.
Smile.fr

Steps To Reproduce

Proposed Solution

Additional Information