Re: [mdt-ocl.dev] Question on doc

[Adolfo Sánchez-Barbudo Herrera <adolfosbh@xxxxxxxxxxxxxxxx>]

Ed, Axel,

I think that I've got a good solution which is also related to my previous post

What about if the build process generates the javadoc for all the MDT/OCL project (in a similar way Xtext does). When publishing the generated javadoc could be moved to the proper place so that for 3.1.0 we will have a similar working URI like the following:

http://download.eclipse.org/modeling/mdt/ocl/javadoc/3.0.0/

The org.eclipse.ocl.doc plugin won't contain any javadoc (which would make our doc plugin unnecessarily increase in size). Instead, in the API Reference topic we will simply create an hyperlink which will refer to the web page above with the javadoc.

Concerning the javadoc, the doc plugin would only require to update such a link with every release...

What do you think?

Best Regards,
Adolfo.

El 15/02/2011 14:18, Willink, Ed escribió:

Hi Axel

In principle yes.

In order to avoid excessive Javadoc bloat, we perhaps should only Javadoc
classes that are likely to be documented and useful to users.

So no Javadoc (beyond perhaps a package-level 'README') for
	EMF generated packages
	LPG generated packages
	Xtext generated packages
	Internal API

and if that adds more than 10% to the ZIPped size, we perhaps should think
harder.

	Regards

		Ed

-----Original Message-----
From: mdt-ocl.dev-bounces@xxxxxxxxxxx 
[mailto:mdt-ocl.dev-bounces@xxxxxxxxxxx] On Behalf Of Axel Uhl
Sent: 15 February 2011 14:10
To: MDT OCL mailing list
Subject: Re: [mdt-ocl.dev] Question on doc

If I understand things correctly, this would mean adding the 
respective 
bundles (particularly 
org.eclipse.ocl.examples.[pivot,eventmanager,impactanalyzer,im
pactanalyzer.util]) 
to the org.eclipse.ode.core.javadoc extension in 
org.eclipse.ocl.doc/plugin.xml. Shall I commit such a change?

Best,
-- Axel

On 2/15/2011 12:20 PM, Adolfo Sánchez-Barbudo Herrera wrote:

Axel,

I agree with you. Now you mention that, I'm not really 

aware of how the

documentation is managed during the building process... It 

would be good

to start looking into this.

P.S: If you have any knowledge concercing this, please let 

me know it.

Cheers,
Adolfo.

El 15/02/2011 11:12, Axel Uhl escribió:

Hi,

org.eclipse.ocl.doc contributes Javadoc for the reference
documentation. Wouldn't it be useful to also add the 

Javadoc for the

examples bundles that are---although an unofficial---sort 

of an API?

IMHO, this would make sense for the Pivot stuff as well as 

for event

manager and impact analyzer. What do you think?

Best,
-- Axel
_______________________________________________
mdt-ocl.dev mailing list
mdt-ocl.dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mdt-ocl.dev

--
Open Canarias, S.L.
	*Adolfo Sánchez-Barbudo Herrera*
adolfosbh(at)opencanarias(dot)com
<mailto:adolfosbh%28at%29opencanarias%28dot%29com>
C/Elías Ramos González, 4, ofc. 304
38001 SANTA CRUZ DE TENERIFE
Tel.: +34 922 240231



_______________________________________________
mdt-ocl.dev mailing list
mdt-ocl.dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mdt-ocl.dev

_______________________________________________
mdt-ocl.dev mailing list
mdt-ocl.dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mdt-ocl.dev

Please consider the environment before printing a hard copy of this 
e-mail. 
 
The information contained in this e-mail is confidential. It is intended 
only for the stated addressee(s) and access to it by any other person is 
unauthorised. If you are not an addressee, you must not disclose, copy, 
circulate or in any other way use or rely on the information contained in 
this e-mail. Such unauthorised use may be unlawful. If you have received 
this e-mail in error, please inform us immediately on +44 (0)118 986 8601 
and delete it and all copies from your system. 
 
Thales Research and Technology (UK) Limited. A company registered in 
England and Wales. Registered Office: 2 Dashwood Lang Road, The Bourne 
Business Park, Addlestone, Weybridge, Surrey KT15 2NX. Registered Number: 
774298 
 
Thales UK Limited. A company registered in England and Wales. Registered 
Office: 2 Dashwood Lang Road, The Bourne Business Park, Addlestone, 
Weybridge, Surrey KT15 2NX. Registered Number: 868273 

_______________________________________________
mdt-ocl.dev mailing list
mdt-ocl.dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mdt-ocl.dev

--

Adolfo Sánchez-Barbudo Herrera adolfosbh(at)opencanarias(dot)com C/Elías Ramos González, 4, ofc. 304 38001 SANTA CRUZ DE TENERIFE Tel.: +34 922 240231