Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 372850

Summary:	[documentation] Revise Documentation for OCL 4.0.0 (Juno)
Product:	[Modeling] OCL	Reporter:	Adolfo Sanchez-Barbudo Herrera <adolfosbh>
Component:	Core	Assignee:	OCL Inbox <mdt-ocl-inbox>
Status:	CLOSED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	ed
Version:	unspecified	Flags:	adolfosbh: review+
Target Milestone:	RC4
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description Adolfo Sanchez-Barbudo Herrera

2012-02-29 08:51:22 EST

When Googling for "OCLinEcoreEObjectValidator", the page title for the second hit (http://download.eclipse.org/modeling/mdt/ocl/javadoc/4.0.0/org/eclipse/ocl/examples/xtext/oclinecore/validation/OCLinEcoreEObjectValidator.html) refers to "MDT/OCL Documentation". 

Ed suggests that Eclipse OCL or Eclipse (MDT) OCL might be better.

Review the overall documentation to look for name convention funnies.

Comment 1 Adolfo Sanchez-Barbudo Herrera

2012-02-29 09:03:28 EST

Another pending issue:

Hep Contents -> OCL DOucmentation -> API Reference -> Javadoc sasy:

"The Javadoc for Eclipse OCL 3.1.0 (Indigo) APIs may be found by following the OCL 3.1.0 API Reference link".

Firstly, This needs to be updated for OCL 4.0.0

Having to manually change with every release, is not practical. Actually, the very error prone since we have missed that for Indigo SR1 and SR2. Ideas to face this up ?

Some quick alternatives:

a) Have an always open bugzilla for that. Similar to that one we used to maintain currency with UML.
b) No specify version/release and use a "latest" URL: http://download.eclipse.org/modeling/mdt/ocl/javadoc/latest
   b.1: Latest redirects  to the real last version (error prone as well)
   b.2: Make the build publish in both URLs (latest and the real last version)

Comment 2 Ed Willink

2012-02-29 09:28:41 EST

All interesting software problems can be solved with an extra level of indirection.

Introduce an http://download.eclipse.org/modeling/mdt/ocl/javadoc/index page with links to all the available versions. Then we just add another line to the index occasionally.

Comment 3 Ed Willink

2012-06-09 08:53:02 EDT

All MDT/OCL's eliminated from Juno documentation.

4.0.0 used throughout.

It seems a moderate but tolerable chore to replace all x.y.z with the next value at release time.

Comment 4 Ed Willink

2012-06-11 04:13:52 EDT

Running the Code Generator tutorial rrevealed one howler.

When I revised ExpressionInOcl to ExpressionInOCL I neglected to update the manual copy of the Acceleo built template; so code gen fails; Bu 371327 is an open Bugzilla on extending testing to use the built code once Acceleo runs on Hudson. It woul;d have caught this.

Please approve the two [unrelated] commits on the bug/327850 branch.

Comment 5 Adolfo Sanchez-Barbudo Herrera

2012-06-11 07:40:21 EDT

+1 for the [unrelated] changes.

While testing this, I've found an other error.... raising a different bugzilla.

Comment 6 Ed Willink

2013-05-20 11:35:22 EDT

CLOSED after a year in the RESOLVED state.