Eclipse Community Forums: EMF » Customizing javadoc for emf's autogenerated classes/methods

Help

Home

Home » Modeling » EMF » Customizing javadoc for emf's autogenerated classes/methods

Show: Today's Messages :: Show Polls :: Message Navigator

Customizing javadoc for emf's autogenerated classes/methods [message #395051]

Tue, 16 August 2005 18:46

Eclipse User

Originally posted by: vu.ha.honeywell.com

Hi, I am an EMF newbie and enjoying it very much.

Questions: How to customize the javadoc portions of the autogenerated
code? For example, I'd like to add a tag @author <my name> to the javadoc
of all autogenerated classes.

I suspect I need to read about JET/JMerge. Am I on the right track? Any
quick trick to do this?

Thanks much in advance.

Vu~

Report message to a moderator

Re: Customizing javadoc for emf's autogenerated classes/methods [message #395055 is a reply to message #395051]

Tue, 16 August 2005 19:37

Ed Merks

Messages: 33137
Registered: July 2009

Senior Member

This is a multi-part message in MIME format.
--------------010405000203010304010104
Content-Type: text/plain; charset=ISO-8859-15; format=flowed
Content-Transfer-Encoding: 7bit

Vu,

Yes, you need to specialize the templates that are being used. You can
use these instructions to search for previous answers on how to
customize the templates:

Eclipse.org Newsgroups - Offline Searching with Mozilla
< http://eclipse.org/emf/docs.php?doc=docs/SearchingNewsgroups /SearchingNewsgroupsMozilla.html>
Outlook Express
< http://eclipse.org/emf/docs.php?doc=docs/SearchingNewsgroups /SearchingNewsgroupsOutlook.html>

Vu Ha wrote:

> Hi, I am an EMF newbie and enjoying it very much.
> Questions: How to customize the javadoc portions of the autogenerated
> code? For example, I'd like to add a tag @author <my name> to the
> javadoc of all autogenerated classes.
> I suspect I need to read about JET/JMerge. Am I on the right track?
> Any quick trick to do this?
>
> Thanks much in advance.
>
> Vu~
>

--------------010405000203010304010104
Content-Type: multipart/related;
boundary="------------070505090908060209080601"

--------------070505090908060209080601
Content-Type: text/html; charset=ISO-8859-15
Content-Transfer-Encoding: 8bit

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-15"
http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
Vu,<br>
<br>
Yes, you need to specialize the templates that are being used.

Ed Merks
Professional Support: https://www.macromodeling.com/

Report message to a moderator

Re: Customizing javadoc for emf's autogenerated classes/methods [message #395060 is a reply to message #395055]

Tue, 16 August 2005 20:03

Eclipse User

Originally posted by: vu.ha.honeywell.com

Thanks Ed. I am currently behind corporate firewall (which makes
newsgroups inaccessible). I'll do as you suggested at home.

I've also quickly skimmed through the JET tutorials on the EMF documents
web page. Good stuffs!

Vu~

Report message to a moderator

Re: Customizing javadoc for emf's autogenerated classes/methods [message #723812 is a reply to message #395055]

Fri, 09 September 2011 14:43

Leonardo Kenji Shikida

Messages: 37
Registered: July 2009

Member

I am afraid this post is too old and the links provided no longer exist.

Where exactly should I change in order to modify the javadoc templates?

TIA

Kenji

Report message to a moderator

Re: Customizing javadoc for emf's autogenerated classes/methods [message #723824 is a reply to message #723812]

Fri, 09 September 2011 14:57

Ed Merks

Messages: 33137
Registered: July 2009

Senior Member

Kenji,

Perhaps what you want to accomplish can be achieved with annotations in
the model (as recognized by EcoreUtil.getDocumentation) rather than with
specialized templates. Can you given an example of what you're hoping
to achieve?

If you really think you need to specialize the templates, read the FAQ
about dynamic templates.

On 09/09/2011 7:43 AM, Leonardo Kenji Shikida wrote:
> I am afraid this post is too old and the links provided no longer exist.
> Where exactly should I change in order to modify the javadoc templates?
>
> TIA
> Kenji

Ed Merks
Professional Support: https://www.macromodeling.com/

Report message to a moderator

Re: Customizing javadoc for emf's autogenerated classes/methods [message #723837 is a reply to message #723824]

Fri, 09 September 2011 16:09

Leonardo Kenji Shikida

Messages: 37
Registered: July 2009

Member

Hi Ed

I have an ecore model. Then I´ve created an ecore diagram for it, so I could click on classes and attributes and define what it calls "GenModel Doc", as described in the tutorial http://www.vogella.de/articles/EclipseEMF/article.html#javadoc (section 7).

Then, from my model, I can generate the java code.

The problem was the generated java code had the comments in each class header and in each get method, mixed with the generated javadoc that EMF generates.

What I had in mind was to customize the templates EMF uses to generate javadoc, so I could leave only the text I´ve provided in the diagram.

My idea was to provide the generated javadoc as a low-level documentation for my client.

But your previous answer, for this thread - http://www.eclipse.org/forums/index.php?t=rview&goto=723825#msg_723825 - generated a clean and nice HTML that will work for me.

TIA

Kenji

Report message to a moderator

Previous Topic:	how do I use org.eclipse.emf.exporter.html ?
Next Topic:	Register adapters

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Fri Apr 19 23:18:05 GMT 2024

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter